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

Some man page improvements #102

Closed
wants to merge 3 commits into from
Closed

Conversation

bigsmoke
Copy link
Contributor

Resolves #101, among other things.

@halfgaar
Copy link
Owner

There are some issues. First small:

flashmq_man_Screenshot_20240512_091614

Then, there are merge mistakes:

flashmq_man2_Screenshot_20240512_091943

This is also reflected by:

touch *.dbk5 ; make
xsltproc db5to4/db5to4-withinfo.xsl flashmq.1.dbk5 > flashmq.1.dbk4
flashmq.1.dbk5:80: element varlistentry: validity error : ID SIGHUP already defined
    <varlistentry xml:id="SIGHUP">
                                 ^
flashmq.1.dbk5:113: element varlistentry: validity error : ID SIGUSR2 already defined
      <varlistentry xml:id="SIGUSR2">

etc

@bigsmoke
Copy link
Contributor Author

I used an EM space as a workaround for the missing space between -c and config_file_path in flashmq(1) .

I also fixed another mistake that I overlooked yesterday.

Apologies for the merge errors. It was a messy rebase due to the whitespace changes that occurred when I added the missing <variablelist> container and increased the indent of its contents. I ended up using -Xours, but, clearly, with insufficient checking, though I was convinced I had been rather thorough.

@halfgaar
Copy link
Owner

I used an EM space as a workaround for the missing space between -c and config_file_path in flashmq(1) .

Yeah, that docbook2x is not perfect...

I also fixed another mistake that I overlooked yesterday.

Apologies for the merge errors. It was a messy rebase due to the whitespace changes that occurred when I added the missing <variablelist> container and increased the indent of its contents. I ended up using -Xours, but, clearly, with insufficient checking, though I was convinced I had been rather thorough.

Technically it's not correct yet. This commit copies sections (SIGHUP and SIGUSR appear twice; github's diff viewer doesn't readily show it, without pressing 'expand all') that are removed again later. The end result looks good, but I'd rather have the commits correct.

@bigsmoke
Copy link
Contributor Author

Ah, yeah. Thanks for triple-checking me! I've done a thorough git rebase --interactive origin/master, editing each commit in turn, including a make -C man to make sure that also the generated stuff is correct at each commit. (It wasn't for one of the commits.)

Rowan Rodrik van der Molen added 3 commits May 15, 2024 00:04
@halfgaar
Copy link
Owner

Merged in 👍

@halfgaar halfgaar closed this May 14, 2024
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.

flashmq its command-line options are not documented in its man page
2 participants