From de73c801f34438c1457118f33e26e688554019d3 Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Wed, 13 Jun 2018 16:00:45 -0700 Subject: [PATCH] doc: port man pages to doclifter Problem reported by Eric S. Raymond (Bug#31803). * man/test.x: Add SYNOPSIS section, since help2man understandably gets confused by the square brackets. * src/ln.c (usage): Omit parenthetical "(Nth form)" in usage, as it confuses doclifter. --- man/test.x | 15 +++++++++++++++ src/ln.c | 8 ++++---- 2 files changed, 19 insertions(+), 4 deletions(-) diff --git a/man/test.x b/man/test.x index 8d5bcff526..a7aaf2c828 100644 --- a/man/test.x +++ b/man/test.x @@ -1,4 +1,19 @@ [NAME] test \- check file types and compare values +[SYNOPSIS] +.B test +.I EXPRESSION +.br +.B test +.br +.\" Quote the square brackets to help doclifter (Bug#31803). +.B "[" +.I EXPRESSION +.B "]" +.br +.B "[ ]" +.br +.B "[" +.I OPTION [DESCRIPTION] .\" Add any additional description here diff --git a/src/ln.c b/src/ln.c index 604493bfc4..7bbd42f71b 100644 --- a/src/ln.c +++ b/src/ln.c @@ -376,10 +376,10 @@ usage (int status) else { printf (_("\ -Usage: %s [OPTION]... [-T] TARGET LINK_NAME (1st form)\n\ - or: %s [OPTION]... TARGET (2nd form)\n\ - or: %s [OPTION]... TARGET... DIRECTORY (3rd form)\n\ - or: %s [OPTION]... -t DIRECTORY TARGET... (4th form)\n\ +Usage: %s [OPTION]... [-T] TARGET LINK_NAME\n\ + or: %s [OPTION]... TARGET\n\ + or: %s [OPTION]... TARGET... DIRECTORY\n\ + or: %s [OPTION]... -t DIRECTORY TARGET...\n\ "), program_name, program_name, program_name, program_name); fputs (_("\ -- 2.47.2