Skip to content

Commit

Permalink
Use consistent silencing of make messages when building man pages.
Browse files Browse the repository at this point in the history
Fix adoc formatting warnings.
  • Loading branch information
BsAtHome committed Dec 20, 2024
1 parent 058f77c commit cd3ec8e
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
3 changes: 2 additions & 1 deletion docs/src/Submakefile
Original file line number Diff line number Diff line change
Expand Up @@ -997,8 +997,9 @@ TARGETS += manpages
# For more information, see https://github.com/asciidoc/asciidoc/issues/44
GENERATED_MANPAGES += $(patsubst $(DOC_DIR)/src/man/%.adoc, $(DOC_DIR)/man/%, $(wildcard $(DOC_DIR)/src/man/man?/*.adoc))
$(DOC_DIR)/man/%: $(DOC_DIR)/src/man/%.adoc
$(ECHO) Making manpage `basename $@`
@mkdir -p `dirname $@`
a2x -v --doctype manpage \
$(Q)a2x --doctype manpage \
--format manpage \
--destination-dir `dirname $@` \
--xsltproc-opts="--nonet" \
Expand Down
4 changes: 2 additions & 2 deletions docs/src/man/man1/halui.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,8 @@ contact) connect the physical button to a HAL debounce filter first.
**halui.mdi-command-**_XX_ bit in::
*halui* looks for INI variables named [HALUI]MDI_COMMAND, and exports
a pin for each command it finds. When the pin is driven TRUE, *halui*
runs the specified MDI command. _XX_ is a two digit number starting at
00. If no [HALUI]MDI_COMMAND variables are set in the INI file, no
runs the specified MDI command. _XX_ is a two digit number starting
at 00. If no [HALUI]MDI_COMMAND variables are set in the INI file, no
halui.mdi-command-XX pins will be exported by halui.

=== Mist coolant
Expand Down
7 changes: 3 additions & 4 deletions docs/src/man/man1/monitor-xhc-hb04.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,9 @@ monitor-xhc-hb04 - monitors the XHC-HB04 pendant and warns of disconnection
This script runs in the background and will pop up a message when the pendant is disconnected or reconnected.

Usage is optional; if used it is specified with INI file entry:
```
[APPLICATIONS]
APP = monitor-xhc-hb04
```
[literal]
[APPLICATIONS]
APP = monitor-xhc-hb04

== SEE ALSO

Expand Down
2 changes: 1 addition & 1 deletion docs/src/man/man1/xhc-hb04.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ pins 3) connect buttons to motion.* pins
Another script is included to monitor the pendant and report loss of USB connectivity.
See the README and .txt files in the above directory for usage.

[Note]
=== Note
The sim configs use the AXIS GUI but the scripts are available
with any HAL configuration or GUI. The same scripts can be used to adapt
the xhc-hb04 to existing configurations provided that the halui, motion,
Expand Down
2 changes: 1 addition & 1 deletion src/hal/components/Submakefile
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ $(COMP_MANPAGES): ../docs/man/man9/%.9: hal/components/%.comp ../bin/halcompile
$(ECHO) Making halcompile manpage $(notdir $@)
@mkdir -p $(dir $@)
$(Q)../bin/halcompile -U --document -o [email protected] $< && preconv -r < [email protected] > $@
$(RM) [email protected]
$(Q)$(RM) [email protected]

$(COMP_DRIVER_MANPAGES): ../docs/man/man9/%.9: hal/drivers/%.comp ../bin/halcompile
$(ECHO) Making halcompile manpage $(notdir $@)
Expand Down

0 comments on commit cd3ec8e

Please sign in to comment.