[PATCH] Add cross-reference for BADNAMES in libstdc++ manual

Jonathan Wakely jwakely@redhat.com
Tue May 16 09:47:00 GMT 2017


The bad names are not in a file called BADNAMES, so link from the old
chunk of documentation to the new position in the manual.

	* doc/xml/manual/appendix_contributing.xml: Link to the list of bad
	identifiers.
	* doc/html/*: Regenerate.

Committed to trunk.


-------------- next part --------------
commit fe4721b08daaf8af40859c9fef15ef7d601906a4
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Tue May 16 10:45:30 2017 +0100

    Add cross-reference for BADNAMES in libstdc++ manual
    
    	* doc/xml/manual/appendix_contributing.xml: Link to the list of bad
    	identifiers.
    	* doc/html/*: Regenerate.

diff --git a/libstdc++-v3/doc/xml/manual/appendix_contributing.xml b/libstdc++-v3/doc/xml/manual/appendix_contributing.xml
index dbc671e..f5b759a 100644
--- a/libstdc++-v3/doc/xml/manual/appendix_contributing.xml
+++ b/libstdc++-v3/doc/xml/manual/appendix_contributing.xml
@@ -898,7 +898,7 @@ indicate a place that may require attention for multi-thread safety.
       Examples: <code>_S_max_elements  _S_default_value</code>
 
       Don't use names in the same scope that differ only in the prefix,
-      e.g. _S_top and _M_top. See BADNAMES for a list of forbidden names.
+      e.g. _S_top and _M_top. See <link linkend="coding_style.bad_identifiers">BADNAMES</link> for a list of forbidden names.
       (The most tempting of these seem to be and "_T" and "__sz".)
 
       Names must never have "__" internally; it would confuse name


More information about the Libstdc++ mailing list