Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing blank line in example of deb-src-control #141

Open
nthykier opened this issue May 8, 2022 · 1 comment
Open

Missing blank line in example of deb-src-control #141

nthykier opened this issue May 8, 2022 · 1 comment

Comments

@nthykier
Copy link
Member

nthykier commented May 8, 2022

Hi,

The man 5 deb-src-control contains an example debian/control file. In regular man, this is rendered with a blank line between the two paragraphs but on https://manpages.debian.org/unstable/dpkg-dev/deb-src-control.5.en.html the blank line is missing has an empty line between the two paragrahs (it is not present in the HTML as far as I can tell, so it is not a rendering issue - something swallowed before it was sent to the browser).

Unfortunately, this missing newline changes the semantics of the example (as it merges the two paragraphs into one).

@stapelberg
Copy link
Contributor

This seems to be an issue with mandoc:

% curl -o- https://manpages.debian.org/unstable/dpkg-dev/deb-src-control.5.en.gz | mandoc
[…]
EXAMPLE
        # Comment
        Source: dpkg
        Section: admin
        Priority: required
        Maintainer: Dpkg Developers <debian-dpkg@lists.debian.org>
        # this field is copied to the binary and source packages
        XBS-Upstream-Release-Status: stable
        Homepage: https://wiki.debian.org/Teams/Dpkg
        Vcs-Browser: https://git.dpkg.org/cgit/dpkg/dpkg.git
        Vcs-Git: https://git.dpkg.org/git/dpkg/dpkg.git
        Standards-Version: 3.7.3
        Build-Depends: pkg-config, debhelper (>= 4.1.81),
         libselinux1-dev (>= 1.28-4) [!linux-any]

        Package: dpkg-dev
        Section: utils
        Priority: optional
        Architecture: all
        # this is a custom field in the binary package
        XB-Mentoring-Contact: Raphael Hertzog <hertzog@debian.org>
        Depends: dpkg (>= 1.14.6), perl5, perl-modules, cpio (>= 2.4.2-2),
         bzip2, lzma, patch (>= 2.2-1), make, binutils, libtimedate-perl
        Recommends: gcc | c-compiler, build-essential
        Suggests: gnupg, debian-keyring
        Conflicts: dpkg-cross (<< 2.0.0), devscripts (<< 2.10.26)
        Replaces: manpages-pl (<= 20051117-1)
        Description: Debian package development tools
         This package provides the development tools (including dpkg-source)
         required to unpack, build and upload Debian source packages.
         .
         Most Debian source packages will require additional tools to build;
         for example, most packages need make and the C compiler gcc.

SEE ALSO
       deb822(5), deb-control(5), deb-version(7), dpkg-source(1)

But, in HTML output mode:

% curl -o- https://manpages.debian.org/unstable/dpkg-dev/deb-src-control.5.en.gz | mandoc -Thtml
[…]
<h1 class="Sh" id="EXAMPLE"><a class="permalink" href="#EXAMPLE">EXAMPLE</a></h1>
<pre> # Comment
 Source: dpkg
 Section: admin
 Priority: required
 Maintainer: Dpkg Developers &lt;debian-dpkg@lists.debian.org&gt;
 # this field is copied to the binary and source packages
 XBS-Upstream-Release-Status: stable
 Homepage: https://wiki.debian.org/Teams/Dpkg
 Vcs-Browser: https://git.dpkg.org/cgit/dpkg/dpkg.git
 Vcs-Git: https://git.dpkg.org/git/dpkg/dpkg.git
 Standards-Version: 3.7.3
 Build-Depends: pkg-config, debhelper (&gt;= 4.1.81),
  libselinux1-dev (&gt;= 1.28-4) [!linux-any]
 Package: dpkg-dev
 Section: utils
 Priority: optional
 Architecture: all
 # this is a custom field in the binary package
 XB-Mentoring-Contact: Raphael Hertzog &lt;hertzog@debian.org&gt;
 Depends: dpkg (&gt;= 1.14.6), perl5, perl-modules, cpio (&gt;= 2.4.2-2),
  bzip2, lzma, patch (&gt;= 2.2-1), make, binutils, libtimedate-perl
 Recommends: gcc | c-compiler, build-essential
 Suggests: gnupg, debian-keyring
 Conflicts: dpkg-cross (&lt;&lt; 2.0.0), devscripts (&lt;&lt; 2.10.26)
 Replaces: manpages-pl (&lt;= 20051117-1)
 Description: Debian package development tools
  This package provides the development tools (including dpkg-source)
  required to unpack, build and upload Debian source packages.
  .
  Most Debian source packages will require additional tools to build;
  for example, most packages need make and the C compiler gcc.
</pre>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>

@ischwarze Is this a known issue? Any idea what could be the problem here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants