FlashMQ icon indicating copy to clipboard operation
FlashMQ copied to clipboard

Some man page improvements

Open bigsmoke opened this issue 1 year ago • 4 comments

Resolves #101, among other things.

bigsmoke avatar May 11 '24 11:05 bigsmoke

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

halfgaar avatar May 11 '24 23:05 halfgaar

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.

bigsmoke avatar May 12 '24 09:05 bigsmoke

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.

halfgaar avatar May 12 '24 22:05 halfgaar

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.)

bigsmoke avatar May 13 '24 10:05 bigsmoke

Merged in :+1:

halfgaar avatar May 14 '24 23:05 halfgaar