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

Update VERSION in Makefile and add documentation for string_view_t #641

Merged
merged 4 commits into from
Oct 28, 2024

Conversation

dantargz
Copy link
Contributor

@dantargz dantargz commented Oct 27, 2024

Add information to the docs about PUGIXML_STRING_VIEW, PUGIXML_HAS_STRING_VIEW, string_view_t and the overloads that use it. Attempted to have the documentation be future-leaning by primarily documenting the (permanent) PUGIXML_HAS_STRING_VIEW define and only mentioning PUGIXML_STRING_VIEW as a note in the documentation for PUGIXML_HAS_STRING_VIEW.

Docs generated with newer version of asciidoctor 2.0.23 which seems to have also moved some of the css around, though I have not noticed a visual difference.

The VERSION variable in the Makefile was accidentally broken in a previous commit by adding the word "version" to pugixmlconfig.hpp. This is the output of the sed command used to define VERSION

The result of the old sed command:

% sed -n 's/.*version \(.*\).*/\1/p' src/pugiconfig.hpp 
1.14
of pugixml this macro will become obsolete.

which caused this behavior when trying to build docs

% make docs/manual.html   
asciidoctor -b html5 -a version=1.14 of pugixml this macro will become obsolete. docs/manual.adoc -o docs/manual.html
asciidoctor: FAILED: input file of is missing
make: *** [docs/manual.html] Error 1

Tweaked the sed command to /q quit after the first occurance of the word "version" to handle this case.

Related: #626

@dantargz dantargz marked this pull request as ready for review October 27, 2024 17:27
Copy link
Owner

@zeux zeux left a comment

Choose a reason for hiding this comment

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

Thanks!

docs/manual.adoc Outdated Show resolved Hide resolved
docs/manual.adoc Outdated Show resolved Hide resolved
@zeux
Copy link
Owner

zeux commented Oct 28, 2024

Fixed c++ capitalization in .adoc, HTML will be regenerated at some point later.

@zeux zeux merged commit 4d0043f into zeux:master Oct 28, 2024
26 of 27 checks passed
@dantargz dantargz deleted the issue-626-documentation branch October 28, 2024 17:45
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.

2 participants