Gentoo Archives: gentoo-dev

From: "Michał Górny" <mgorny@g.o>
To: gentoo-dev@l.g.o, base-system@g.o
Subject: Re: [gentoo-dev] [PATCH v1] eclass/savedconfig.eclass: rewrite the ROFF macros
Date: Fri, 08 Nov 2019 06:50:26
Message-Id: 1c425f7a137923bede9f1bdbc4ea2feb02eec6f4.camel@gentoo.org
In Reply to: [gentoo-dev] [PATCH v1] eclass/savedconfig.eclass: rewrite the ROFF macros by "Göktürk Yüksek"
1 On Thu, 2019-11-07 at 18:56 -0500, Göktürk Yüksek wrote:
2 > man2html cannot cope with multi-character number-register names and
3 > also doesn't recognize the square brackets in the '\n' escape
4 > sequence. This breaks the autogenerated HTML output. Rename the
5 > number-register from "step" to "R" and get rid of the square brackets.
6 >
7 > Closes: https://bugs.gentoo.org/699476
8 >
9 > Signed-off-by: Göktürk Yüksek <gokturk@g.o>
10 > ---
11 > eclass/savedconfig.eclass | 10 +++++-----
12 > 1 file changed, 5 insertions(+), 5 deletions(-)
13 >
14 > diff --git a/eclass/savedconfig.eclass b/eclass/savedconfig.eclass
15 > index dab2283fe0f..8f64c5b8edd 100644
16 > --- a/eclass/savedconfig.eclass
17 > +++ b/eclass/savedconfig.eclass
18 > @@ -14,20 +14,20 @@
19 > # so users can modify these config files and the ebuild will take it
20 > # into account as needed.
21 > #
22 > -# @ROFF .nr step 1 1
23 > +# @ROFF .nr R 1 1
24 > # Typically you can create your own configuration files quickly by
25 > # doing:
26 > -# @ROFF .IP \n[step] 3
27 > +# @ROFF .IP \nR 3
28 > # Build the package with FEATURES=noclean USE=savedconfig.
29 > -# @ROFF .IP \n+[step]
30 > +# @ROFF .IP \n+R
31 > # Go into the build dir and edit the relevant configuration system
32 > # (e.g. `make menuconfig` or `nano config-header.h`). You can look
33 > # at the files in /etc/portage/savedconfig/ to see what files get
34 > # loaded/restored.
35 > -# @ROFF .IP \n+[step]
36 > +# @ROFF .IP \n+R
37 > # Copy the modified configuration files out of the workdir and to
38 > # the paths in /etc/portage/savedconfig/.
39 > -# @ROFF .IP \n+[step]
40 > +# @ROFF .IP \n+R
41 > # Emerge the package with just USE=savedconfig to get the custom build.
42 >
43 > inherit portability
44
45 Not a ROFF expert but looks reasonable.
46
47 --
48 Best regards,
49 Michał Górny

Attachments

File name MIME type
signature.asc application/pgp-signature