wbrawner/toolbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc, test/system: Fix the titles of the manuals

Browse source 
Currently, the titles of the manuals are rendered with a pair of empty
parentheses and no section title:
  toolbox(1)()                                              toolbox(1)()

  NAME
         toolbox - Tool for containerized command line environments...

However, they should be:
  toolbox(1)             General Commands Manual              toolbox(1)

  NAME
         toolbox - Tool for containerized command line environments...

This is because the troff generated by go-md2man from Markdown has a
faulty invocation of the .TH macro [1]:
  .nh
  .TH toolbox(1)
  .SH NAME
  .PP
  toolbox - Tool for containerized command line environments on Linux

It should be:
  .nh
  .TH toolbox 1
  .SH NAME
  .PP
  toolbox - Tool for containerized command line environments on Linux

Original patch from Andrew Denton for Podman [2].

[1] https://www.gnu.org/software/groff/manual/groff.html

[2] Podman commit 63c779a857b55b00
    https://github.com/containers/podman/pull/15621

https://github.com/containers/toolbox/pull/1210
This commit is contained in:
Debarshi Ray 2023-01-11 20:19:44 +01:00
parent cac6b25f19
commit 936a157117
11 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/toolbox-create.1.md
View file

@ -1,4 +1,4 @@
% toolbox-create(1) % toolbox-create 1
## NAME ## NAME
toolbox\-create - Create a new toolbox container toolbox\-create - Create a new toolbox container

2
doc/toolbox-enter.1.md
View file

@ -1,4 +1,4 @@
% toolbox-enter(1) % toolbox-enter 1
## NAME ## NAME
toolbox\-enter - Enter a toolbox container for interactive use toolbox\-enter - Enter a toolbox container for interactive use

2
doc/toolbox-help.1.md
View file

@ -1,4 +1,4 @@
% toolbox-help(1) % toolbox-help 1
## NAME ## NAME
toolbox\-help - Display help information about Toolbox toolbox\-help - Display help information about Toolbox

2
doc/toolbox-init-container.1.md
View file

@ -1,4 +1,4 @@
% toolbox-init-container(1) % toolbox-init-container 1
## NAME ## NAME
toolbox\-init\-container - Initialize a running container toolbox\-init\-container - Initialize a running container

2
doc/toolbox-list.1.md
View file

@ -1,4 +1,4 @@
% toolbox-list(1) % toolbox-list 1
## NAME ## NAME
toolbox\-list - List existing toolbox containers and images toolbox\-list - List existing toolbox containers and images

2
doc/toolbox-rm.1.md
View file

@ -1,4 +1,4 @@
% toolbox-rm(1) % toolbox-rm 1
## NAME ## NAME
toolbox\-rm - Remove one or more toolbox containers toolbox\-rm - Remove one or more toolbox containers

2
doc/toolbox-rmi.1.md
View file

@ -1,4 +1,4 @@
% toolbox-rmi(1) % toolbox-rmi 1
## NAME ## NAME
toolbox\-rmi - Remove one or more toolbox images toolbox\-rmi - Remove one or more toolbox images

2
doc/toolbox-run.1.md
View file

@ -1,4 +1,4 @@
% toolbox-run(1) % toolbox-run 1
## NAME ## NAME
toolbox\-run - Run a command in an existing toolbox container toolbox\-run - Run a command in an existing toolbox container

2
doc/toolbox.1.md
View file

@ -1,4 +1,4 @@
% toolbox(1) % toolbox 1
## NAME ## NAME
toolbox - Tool for containerized command line environments on Linux toolbox - Tool for containerized command line environments on Linux

2
doc/toolbox.conf.5.md
View file

@ -1,4 +1,4 @@
% toolbox.conf(5) % toolbox.conf 5
## NAME ## NAME
toolbox.conf - Toolbox configuration file toolbox.conf - Toolbox configuration file

3
test/system/002-help.bats
View file

@ -42,7 +42,8 @@ setup() {
run $TOOLBOX help run $TOOLBOX help
assert_success assert_success
assert_line --index 0 --partial "toolbox(1)()" assert_line --index 0 --partial "toolbox(1)"
assert_line --index 0 --partial "General Commands Manual"
} }
@test "help: Run command 'help' with no man present" { @test "help: Run command 'help' with no man present" {