Skip to content

doxygen2man: fix printing of lines starting with '.'#431

Merged
chrissie-c merged 1 commit intoClusterLabs:masterfrom
chrissie-c:quote-dots
Jan 7, 2021
Merged

doxygen2man: fix printing of lines starting with '.'#431
chrissie-c merged 1 commit intoClusterLabs:masterfrom
chrissie-c:quote-dots

Conversation

@chrissie-c
Copy link
Copy Markdown
Contributor

if a line starts with a '.' (eg the '...' in qbarray.h) then
nroff thinks it's looking for a macro called '..'.

The easiest solution is to add a dummy format at the start of the line
(just adding \ seems not to work).

#428

@wferi
Copy link
Copy Markdown
Contributor

wferi commented Jan 4, 2021

\fN works for me, but I couldn't find it documented anywhere. Is it really safe/portable? The usual practice of escaping the leading dot seems to be replacing it by \[char46].

if a line starts with a '.' (eg the '...' in qbarray.h) then
nroff thinks it's looking for a macro called '..'.

The easiest solution is to add a dummy format at the start of the line
(just adding \ seems not to work).
@chrissie-c
Copy link
Copy Markdown
Contributor Author

I didn't know about that escape system, thanks. I've force-pushed that as a better fix. \fN is used all over the man pages so I'm pretty sure it works, but if [char46] is usual practice then I will go with that.

@chrissie-c
Copy link
Copy Markdown
Contributor Author

retest this please

(CI testing)

@chrissie-c chrissie-c merged commit 47ed440 into ClusterLabs:master Jan 7, 2021
@chrissie-c chrissie-c deleted the quote-dots branch January 7, 2021 09:08
bmwiedemann pushed a commit to bmwiedemann/openSUSE that referenced this pull request Oct 11, 2021
https://build.opensuse.org/request/show/924180
by user yan_gao + dimstar_suse
- Update to version 2.0.3+20210303.404adbc (v2.0.3):
- syslog: Add a message-id parameter for messages (gh#ClusterLabs/libqb#433)
- timers: Add some locking (gh#ClusterLabs/libqb#436)
- ipcc: Have a few goes at tidying up after a dead server (gh#ClusterLabs/libqb#434)
- strlcpy: Check for maxlen underflow (gh#ClusterLabs/libqb#432)
- doxygen2man: fix printing of lines starting with '.' (gh#ClusterLabs/libqb#431)
- doxygen2man: ignore all-whitespace brief descriptions (gh#ClusterLabs/libqb#430) (forwarded request 924179 from yan_gao)
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