public inbox for gentoo-dev@lists.gentoo.org
 help / color / mirror / Atom feed
* [gentoo-dev] [PATCH v1] eclass/savedconfig.eclass: rewrite the ROFF macros
@ 2019-11-07 23:56 Göktürk Yüksek
  2019-11-08  6:49 ` Michał Górny
  0 siblings, 1 reply; 2+ messages in thread
From: Göktürk Yüksek @ 2019-11-07 23:56 UTC (permalink / raw
  To: base-system; +Cc: gentoo-dev

man2html cannot cope with multi-character number-register names and
also doesn't recognize the square brackets in the '\n' escape
sequence. This breaks the autogenerated HTML output. Rename the
number-register from "step" to "R" and get rid of the square brackets.

Closes: https://bugs.gentoo.org/699476

Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
---
 eclass/savedconfig.eclass | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/eclass/savedconfig.eclass b/eclass/savedconfig.eclass
index dab2283fe0f..8f64c5b8edd 100644
--- a/eclass/savedconfig.eclass
+++ b/eclass/savedconfig.eclass
@@ -14,20 +14,20 @@
 # so users can modify these config files and the ebuild will take it
 # into account as needed.
 #
-# @ROFF .nr step 1 1
+# @ROFF .nr R 1 1
 # Typically you can create your own configuration files quickly by
 # doing:
-# @ROFF .IP \n[step] 3
+# @ROFF .IP \nR 3
 # Build the package with FEATURES=noclean USE=savedconfig.
-# @ROFF .IP \n+[step]
+# @ROFF .IP \n+R
 # Go into the build dir and edit the relevant configuration system
 # (e.g. `make menuconfig` or `nano config-header.h`).  You can look
 # at the files in /etc/portage/savedconfig/ to see what files get
 # loaded/restored.
-# @ROFF .IP \n+[step]
+# @ROFF .IP \n+R
 # Copy the modified configuration files out of the workdir and to
 # the paths in /etc/portage/savedconfig/.
-# @ROFF .IP \n+[step]
+# @ROFF .IP \n+R
 # Emerge the package with just USE=savedconfig to get the custom build.
 
 inherit portability
-- 
2.24.0



^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [gentoo-dev] [PATCH v1] eclass/savedconfig.eclass: rewrite the ROFF macros
  2019-11-07 23:56 [gentoo-dev] [PATCH v1] eclass/savedconfig.eclass: rewrite the ROFF macros Göktürk Yüksek
@ 2019-11-08  6:49 ` Michał Górny
  0 siblings, 0 replies; 2+ messages in thread
From: Michał Górny @ 2019-11-08  6:49 UTC (permalink / raw
  To: gentoo-dev, base-system

[-- Attachment #1: Type: text/plain, Size: 1791 bytes --]

On Thu, 2019-11-07 at 18:56 -0500, Göktürk Yüksek wrote:
> man2html cannot cope with multi-character number-register names and
> also doesn't recognize the square brackets in the '\n' escape
> sequence. This breaks the autogenerated HTML output. Rename the
> number-register from "step" to "R" and get rid of the square brackets.
> 
> Closes: https://bugs.gentoo.org/699476
> 
> Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
> ---
>  eclass/savedconfig.eclass | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/eclass/savedconfig.eclass b/eclass/savedconfig.eclass
> index dab2283fe0f..8f64c5b8edd 100644
> --- a/eclass/savedconfig.eclass
> +++ b/eclass/savedconfig.eclass
> @@ -14,20 +14,20 @@
>  # so users can modify these config files and the ebuild will take it
>  # into account as needed.
>  #
> -# @ROFF .nr step 1 1
> +# @ROFF .nr R 1 1
>  # Typically you can create your own configuration files quickly by
>  # doing:
> -# @ROFF .IP \n[step] 3
> +# @ROFF .IP \nR 3
>  # Build the package with FEATURES=noclean USE=savedconfig.
> -# @ROFF .IP \n+[step]
> +# @ROFF .IP \n+R
>  # Go into the build dir and edit the relevant configuration system
>  # (e.g. `make menuconfig` or `nano config-header.h`).  You can look
>  # at the files in /etc/portage/savedconfig/ to see what files get
>  # loaded/restored.
> -# @ROFF .IP \n+[step]
> +# @ROFF .IP \n+R
>  # Copy the modified configuration files out of the workdir and to
>  # the paths in /etc/portage/savedconfig/.
> -# @ROFF .IP \n+[step]
> +# @ROFF .IP \n+R
>  # Emerge the package with just USE=savedconfig to get the custom build.
>  
>  inherit portability

Not a ROFF expert but looks reasonable.

-- 
Best regards,
Michał Górny


[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 618 bytes --]

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2019-11-08  6:50 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-11-07 23:56 [gentoo-dev] [PATCH v1] eclass/savedconfig.eclass: rewrite the ROFF macros Göktürk Yüksek
2019-11-08  6:49 ` Michał Górny

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox