* [PATCH] Add cross-reference for BADNAMES in libstdc++ manual
@ 2017-05-16 9:54 Jonathan Wakely
2017-05-16 11:03 ` Jonathan Wakely
0 siblings, 1 reply; 2+ messages in thread
From: Jonathan Wakely @ 2017-05-16 9:54 UTC (permalink / raw)
To: libstdc++, gcc-patches
[-- Attachment #1: Type: text/plain, Size: 262 bytes --]
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.
[-- Attachment #2: patch.txt --]
[-- Type: text/plain, Size: 1159 bytes --]
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
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH] Add cross-reference for BADNAMES in libstdc++ manual
2017-05-16 9:54 [PATCH] Add cross-reference for BADNAMES in libstdc++ manual Jonathan Wakely
@ 2017-05-16 11:03 ` Jonathan Wakely
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Wakely @ 2017-05-16 11:03 UTC (permalink / raw)
To: libstdc++, gcc-patches
[-- Attachment #1: Type: text/plain, Size: 364 bytes --]
On 16/05/17 10:47 +0100, Jonathan Wakely wrote:
>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.
Another cross-reference, committed to trunk.
[-- Attachment #2: patch.txt --]
[-- Type: text/x-patch, Size: 1162 bytes --]
commit 44a0bb0aa0449b85a96f46234aa6245d4e972fd7
Author: Jonathan Wakely <jwakely@redhat.com>
Date: Tue May 16 11:37:01 2017 +0100
Add cross-reference for test permutations in libstdc++ manual
* doc/xml/manual/appendix_contributing.xml: Link to test docs and
note higher DejaGnu version requirement.
* doc/html/*: Regenerate.
diff --git a/libstdc++-v3/doc/xml/manual/appendix_contributing.xml b/libstdc++-v3/doc/xml/manual/appendix_contributing.xml
index f5b759a..4133547 100644
--- a/libstdc++-v3/doc/xml/manual/appendix_contributing.xml
+++ b/libstdc++-v3/doc/xml/manual/appendix_contributing.xml
@@ -358,7 +358,9 @@ It has subdirectories:
library. Support for "make check" and "make check-install" is
complete, and runs through all the subdirectories here when this
command is issued from the build directory. Please note that
- "make check" requires DejaGNU 1.4 or later to be installed.
+ "make check" requires DejaGnu 1.4 or later to be installed,
+ or for extra <link linkend="test.run.permutations">permutations</link>
+ DejaGnu 1.5.3 or later.
</listitem>
</varlistentry>
</variablelist>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2017-05-16 10:37 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-05-16 9:54 [PATCH] Add cross-reference for BADNAMES in libstdc++ manual Jonathan Wakely
2017-05-16 11:03 ` Jonathan Wakely
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).