Skip to content
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

[lib] Add main index entries for all headers. #1197

Merged
merged 1 commit into from Dec 8, 2016

Conversation

jensmaurer
Copy link
Member

@jensmaurer jensmaurer commented Dec 8, 2016

Fixes #940.

@@ -5840,7 +5846,9 @@
\end{codeblock}

\rSec2[associative.set.syn]{Header \tcode{<set>} synopsis}%
\indexlibrary{\idxhdr{set}}

\indextext{\idxhdr{set}}%
Copy link
Contributor

@tkoeppe tkoeppe Dec 8, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Escaping the newline is a bit pointless if the whole thing is surrounded by whitespace :-S

I would mildly suggest to not bother escaping newlines for index entries in between blocks... eh, I don't really care, it's just a bit of a pointless addition.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. We seem to generally escape newlines for \indexXXX things.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, that was my point. That is pure non-semantic cargoculting. But I suppose it means that people who don't know what's going on are less prone to break something, so I'm OK with it.

@@ -15058,7 +15082,9 @@
\end{codeblock}

\pnum
\indextext{\idxhdr{inttypes.h}}%
Copy link
Contributor

@tkoeppe tkoeppe Dec 8, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(By contrast, it is crucial that these index entries not introduce whitespace, so that the paragraph begins on the left margin, so here the escaping is appropriate.)

@tkoeppe
Copy link
Contributor

tkoeppe commented Dec 8, 2016

I'm happy to merge this. Did you double-check the index that it all comes out as desired?

@jensmaurer
Copy link
Member Author

jensmaurer commented Dec 8, 2016

I used diffpdf on the index (which is semi-useful in this case) and it shows all kinds of new <blah> entries, as expected.

@tkoeppe tkoeppe merged commit 23b02f5 into cplusplus:master Dec 8, 2016
@jensmaurer jensmaurer deleted the b8 branch December 8, 2016 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants