New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[atomics] Clean up indexing of atomics clause #1038
Conversation
@@ -427,6 +427,7 @@ | |||
|
|||
\rSec1[atomics.types.generic]{Atomic types} | |||
|
|||
\indexlibrary{\idxcode{atomic<\placeholder{type}>}}% |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the primary template, we just use \indexlibrary{\idxcode{atomic}}%
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe index entries for atomic<
integral
>
and atomic<T*>
might make sense, though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replaced all uses of atomic with just atomic, where appropriate to that type. Added fresh entries for atomic and atomic<T*>, to better index their larger interfaces. Then removed any remaining references to atomic.
@@ -763,7 +808,7 @@ | |||
operations on non-volatile objects become volatile. Thus, volatile qualified operations | |||
on non-volatile objects may be merged under some conditions. \end{note} | |||
|
|||
\indexlibrary{\idxcode{atomic type}!constructor}% | |||
\indexlibrary{\idxcode{atomic<\placeholder{type}>}!constructor}% |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Likewise here, just \indexlibrary{\idxcode{atomic}!constructor}%
would be in line with what we do elsewhere.
Please also fix the commit message to refer to the clause's stable name. |
6fd2ac6
to
e56ff54
Compare
d2a10b4
to
c1f9b30
Compare
e56ff54
to
963155d
Compare
963155d
to
094a5f1
Compare
Rebased onto current master and pushed again, with updated headline as requested by @tkoeppe. This patch has some additional index entries that I had missed on the first pass, and makes some (but not exhaustive) tweaks in the main text to use \placeholder for consistency with the indexed use. It is probably worth a fresh review, rather than just comparing to changes in the last one. |
Are you still around for a final rebase? |
Reverse class/member names in indexlibrarymember macros to be consistent with the prefered style in other clauses. Expand in the index several functions that are documented as a pattern-match, such as fetch_add and fetch_sub. Replace 'atomic type' for index references with either just 'atomic', 'atomic<integral>', or 'atomic<T*>' to follow existing conventions for documenting templates, and to more clearly call out the larger interfaces of the defined specializations. Added further indexing for a few items that had missed index entries in the first pass.
094a5f1
to
0072e5a
Compare
Rebased and pushed. |
Reverse class/member names in indexlibrarymember macros to be
consistent with the prefered style in other clauses.
Expand in the index several functions that are documented as a
pattern-match, such as fetch_add and fetch_sub.
Use 'atomic' rather than 'atomic type' for index references
to the atomic template. This allows for a more intuitive indexing
of the conversion operator.