[release-notes] Style issues

John J. McDonough jjmcd at fedoraproject.org
Mon May 13 12:47:21 UTC 2013


commit 2ce88a1b0343a1f56cd156564b0effe0ae158586
Author: John J. McDonough <jjmcd at fedoraproject.org>
Date:   Mon May 13 08:44:37 2013 -0400

    Style issues
    
    Within F-R-N we generally do not like to use the word "see" as in "see
    this link for more details", as it can be an uncomdortable reminder to
    visually impaired readers.  This commit exchanges many (but not all)
    of those references for terms like "visit", "may be found at", "refer
    to", etc.

 en-US/Desktop.xml               |    2 +-
 en-US/Development.xml           |    2 +-
 en-US/Development_GCC_Tools.xml |    6 +++---
 en-US/Development_Java.xml      |    5 ++++-
 en-US/Virtualization.xml        |   39 ++++++++++++++++++++++++---------------
 5 files changed, 33 insertions(+), 21 deletions(-)
---
diff --git a/en-US/Desktop.xml b/en-US/Desktop.xml
index 839a59f..ad36f12 100644
--- a/en-US/Desktop.xml
+++ b/en-US/Desktop.xml
@@ -18,7 +18,7 @@
   <section>
     <title>GNOME</title>
     <para>
-      Fedora PRODVER; includes the latest version of the <application>GNOME</application> desktop, 3.8. For more information about what is new in this GNOME release, see the project's release notes at <ulink url="http://library.gnome.org/misc/release-notes/3.8" />
+      Fedora PRODVER; includes the latest version of the <application>GNOME</application> desktop, 3.8. For more information about what is new in this GNOME release, visit the project's release notes at <ulink url="http://library.gnome.org/misc/release-notes/3.8" />
     </para>
   </section>
 
diff --git a/en-US/Development.xml b/en-US/Development.xml
index c5e53d2..559ea2e 100644
--- a/en-US/Development.xml
+++ b/en-US/Development.xml
@@ -26,7 +26,7 @@
     <para>
       The popular programming language <package>PHP</package> has been updated to version 5.5.0 .This includes a number of significant new features, including support for <ulink url="http://www.php.net/generators">Generators</ulink>, new <application>Zend OPcache</application> extension as well as a number of performance enhancements.
     </para>
-      <para>For complete details see Migrating from PHP 5.4.x to PHP 5.5.x  PHP developers should read <filename>/usr/share/doc/php-common-*/NEWS</filename> to learn about the changes and consult the migration guide at <ulink url="http://www.php.net/manual/en/migration55.php" />.
+      <para>For complete details refer to Migrating from PHP 5.4.x to PHP 5.5.x  PHP developers should read <filename>/usr/share/doc/php-common-*/NEWS</filename> to learn about the changes and consult the migration guide at <ulink url="http://www.php.net/manual/en/migration55.php" />.
     </para>
   </section>
 
diff --git a/en-US/Development_GCC_Tools.xml b/en-US/Development_GCC_Tools.xml
index 8c153f3..82ddf52 100644
--- a/en-US/Development_GCC_Tools.xml
+++ b/en-US/Development_GCC_Tools.xml
@@ -12,13 +12,13 @@
       As of Fedora &PRODVER;, GCC 4.8.x is shipped as the default GCC. In addition, all Fedora packages have been rebuilt with GCC 4.8.x (and GLIBC 2.17; see below)
     </para>
     <para>
-      Users will be able to see compiled code improvements and use the newly added features, such as improved C++11 and C11 support, improved vectorization support, etc.
+      Users will be able to examine compiled code improvements and use the newly added features, such as improved C++11 and C11 support, improved vectorization support, etc.
     </para>
     <para>
       Updates to GCC include the <package>MinGW</package> cross-compiler.  One of the most notable changes is that the default exception handling model for the <function>win64</function> target was changed from <function>SjLj</function> to <function>SEH</function>. The <function>win32</function> target still uses the <function>SjLj</function> exception handling model. This causes all binaries for the <function>win64</function> target which use exception handling to depend on <filename>libgcc_s_seh-1.dll</filename> instead of <filename>libgcc_s_sjlj-1.dll</filename>.
     </para>
     <para>
-      For more information on the changes in GCC 4.8.x, please see <ulink url="http://gcc.gnu.org/gcc-4.8/changes.html" />
+      For more information on the changes in GCC 4.8.x, please visit <ulink url="http://gcc.gnu.org/gcc-4.8/changes.html" />
     </para>
   </section>
   
@@ -28,7 +28,7 @@
       As of Fedora 19, GLIBC 2.17 is shipped as the default GLIBC. All Fedora packages have been rebuilt with GLIBC 2.17 (and GCC 4.8.x; see above).
     </para>
     <para>
-      For more information on the changes in GLIBC 2.17, please see <ulink url="http://sourceware.org/ml/libc-announce/2012/msg00001.html" />
+      For more information on the changes in GLIBC 2.17, please refer to <ulink url="http://sourceware.org/ml/libc-announce/2012/msg00001.html" />
     </para>
   </section>
 
diff --git a/en-US/Development_Java.xml b/en-US/Development_Java.xml
index 665fed0..3178dfe 100644
--- a/en-US/Development_Java.xml
+++ b/en-US/Development_Java.xml
@@ -32,7 +32,10 @@
   <section>
     <title>Simplified <package>Maven</package> packaging</title>
     <para>
-      Improved and simplified way to create RPM packages out of <application>Apache Maven</application> projects have been introduced. For details and conversion recipes from old spec files, see <ulink url="http://mizdebsk.fedorapeople.org/xmvn/cookbook/" />
+      Improved and simplified way to create RPM packages out of
+      <application>Apache Maven</application> projects have been
+      introduced. Details and conversion recipes from old spec
+      files may be found at <ulink url="http://mizdebsk.fedorapeople.org/xmvn/cookbook/" />
     </para>
   </section> 
 
diff --git a/en-US/Virtualization.xml b/en-US/Virtualization.xml
index eba4647..a825d68 100644
--- a/en-US/Virtualization.xml
+++ b/en-US/Virtualization.xml
@@ -91,73 +91,82 @@
         <section>
           <title>Ceilomeer</title>
           <para>
-            This OpenStack incubation project is new in this release. Please see <ulink url="http://fedoraproject.org/wiki/Test_Day:2013-04-02_OpenStack#Ceilometer_functionality">Ceilometer preliminary setup notes</ulink>.
+            This OpenStack incubation project is new in this
+	    release. Please refer to <ulink url="http://fedoraproject.org/wiki/Test_Day:2013-04-02_OpenStack#Ceilometer_functionality">Ceilometer preliminary setup notes</ulink>.
           </para>
         </section>
       
         <section>
           <title>Heat</title>
           <para>
-            This OpenStack incubation project is new in this release. Please see <ulink url="http://fedoraproject.org/wiki/Test_Day:2013-04-02_OpenStack#Heat_basic_functionality">Heat preliminary setup notes</ulink>
+            This OpenStack incubation project is new in this release. Please visit <ulink url="http://fedoraproject.org/wiki/Test_Day:2013-04-02_OpenStack#Heat_basic_functionality">Heat preliminary setup notes</ulink>
           </para>
         </section>
 
         <section>
           <title>Nova</title>
           <para>
-            <application>Nova</application> volumes removed in favor of <application>cinder</application>, see <ulink url="https://blueprints.launchpad.net/nova/+spec/delete-nova-volume" />
+            <application>Nova</application> volumes removed in favor
+	    of <application>cinder</application>, refer to <ulink url="https://blueprints.launchpad.net/nova/+spec/delete-nova-volume" />
           </para>
           <para>
-            Compute nodes no longer access the database to support greater scalability and security, see <ulink url="https://blueprints.launchpad.net/nova/+spec/no-db-compute" />
+            Compute nodes no longer access the database to support
+	    greater scalability and security, refer to <ulink url="https://blueprints.launchpad.net/nova/+spec/no-db-compute" />
           </para>
           <para>
-            Snapshots can done to block devices as well as <function>>qcow2</function>> files, see <ulink url="https://blueprints.launchpad.net/nova/+spec/snapshots-for-everyone" />
+            Snapshots can done to block devices as well as
+	    <function>>qcow2</function>> files, refer to <ulink url="https://blueprints.launchpad.net/nova/+spec/snapshots-for-everyone" />
           </para>
           <para>
-            <function>compute cells</function> was merged to support greater scalability, see <ulink url="https://blueprints.launchpad.net/nova/+spec/nova-compute-cells" />
+            <function>compute cells</function> was merged to support
+	    greater scalability, refer to <ulink url="https://blueprints.launchpad.net/nova/+spec/nova-compute-cells" />
           </para>
           <para>
-            <package>libvirt</package> now supports <function>SPICE</function> as well as <function>VNC</function>, see <ulink url="https://blueprints.launchpad.net/nova/+spec/libvirt-spice" />
+            <package>libvirt</package> now supports
+	    <function>SPICE</function> as well as
+	    <function>VNC</function>, refer to <ulink url="https://blueprints.launchpad.net/nova/+spec/libvirt-spice" />
           </para>
         </section>
 
         <section>
           <title>Quantum</title>
           <para>
-            Security groups are now supported, see <ulink url="https://blueprints.launchpad.net/quantum/+spec/quantum-security-groups" />
+            Security groups are now supported, details may be found at <ulink url="https://blueprints.launchpad.net/quantum/+spec/quantum-security-groups" />
           </para>
         </section>
         
         <section>
           <title>Cinder</title>
           <para>
-            Volume backup to <application>swift</application> is now available, see <ulink url="https://blueprints.launchpad.net/cinder/+spec/volume-backups" />
+            Volume backup to <application>swift</application> is now available, visit <ulink url="https://blueprints.launchpad.net/cinder/+spec/volume-backups" />
           </para>
           <para>
-            LIO iSCSI target support, see <ulink url="https://blueprints.launchpad.net/cinder/+spec/lio-iscsi-support" />
+            LIO iSCSI target support, refer to <ulink url="https://blueprints.launchpad.net/cinder/+spec/lio-iscsi-support" />
           </para>
         </section>
       
         <section>
           <title>Keystone</title>
           <para>
-            A new <function>V3</function> API has been impemented, see <ulink url="https://blueprints.launchpad.net/keystone/+spec/implement-v3-core-api" />
+            A new <function>V3</function> API has been impemented,
+	    details at <ulink url="https://blueprints.launchpad.net/keystone/+spec/implement-v3-core-api" />
           </para>
           <para>
-            A new <function>LDAP</function> backend has been introduced, see <ulink url="https://blueprints.launchpad.net/keystone/+spec/ad-ldap-identity-backend" /> 
+            A new <function>LDAP</function> backend has been
+	    introduced, learn more at <ulink url="https://blueprints.launchpad.net/keystone/+spec/ad-ldap-identity-backend" /> 
           </para>
         </section>
       
         <section>
           <title>Horizon</title>
           <para>
-            File uploads have been improved, see <ulink url="https://blueprints.launchpad.net/horizon/+spec/file-upload-redux" />
+            File uploads have been improved, refer to <ulink url="https://blueprints.launchpad.net/horizon/+spec/file-upload-redux" />
           </para>
           <para>
-            Unified config has been implemented to simplify administration, see <ulink url="https://blueprints.launchpad.net/horizon/+spec/unify-config" />
+            Unified config has been implemented to simplify administration, visit<ulink url="https://blueprints.launchpad.net/horizon/+spec/unify-config" />
           </para>
           <para>
-            A system info panel was added, see <ulink url="https://blueprints.launchpad.net/horizon/+spec/system-info-panel" />
+            A system info panel was added, refer to <ulink url="https://blueprints.launchpad.net/horizon/+spec/system-info-panel" />
           </para>
         </section>
         


More information about the docs-commits mailing list