[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

[Git][lintian/lintian][master] 2 commits: Fix clearly invalid Markdown tag descriptions



Title: GitLab

Louis-Philippe Véronneau pushed to branch master at lintian / lintian

Commits:

  • 43279978
    by Nicolas Peugnet at 2024-10-31T18:52:11+00:00
    Fix clearly invalid Markdown tag descriptions
    
    Some descriptions contained clearly invalid Markdown, which caused
    rendering bugs in Lintian SSG, but also in the HTML output of
    lintian-explain-tags.
    
    The text, JSON and HTML format output of lintian-explain-tags have
    been checked.
    
    See-also: https://salsa.debian.org/lintian/lintian-ssg/-/blob/106ab1c22f37a05342524bf31787a0e756a43b87/TODO.md#lintian-tag-sources
    
  • e7e2d023
    by Nicolas Peugnet at 2024-10-31T18:52:11+00:00
    Fix some more invalid <code> tags in literal blocks
    

8 changed files:

Changes:

  • tags/d/desktop-entry-file-has-crs.tag
    ... ... @@ -9,6 +9,6 @@ Explanation: The desktop entry file has lines ending in carriage-return and line
    9 9
      .
    
    10 10
      You can run the following command to remove any <code>CR</code> character in a file:
    
    11 11
      .
    
    12
    -      <code>sed -i 's/\r//g' path/to/file</code>
    
    12
    +     sed -i 's/\r//g' path/to/file
    
    13 13
     See-Also:
    
    14 14
      https://specifications.freedesktop.org/desktop-entry-spec/latest/ar01s03.html

  • tags/d/dfsg-version-with-period.tag
    ... ... @@ -10,4 +10,4 @@ Explanation: The version contains the string <code>.dfsg</code>.
    10 10
      It is better to use <code>+dfsg</code> instead. The plus sign <code>+</code> sorts
    
    11 11
      before <code>.</code>, so the sorting that is usually desired can take place:
    
    12 12
      .
    
    13
    -   <code>1.2</code> &lt; <code>1.2+dfsg</code> &lt; <code>1.2.1</code>
    13
    + <code>1.2</code> &lt; <code>1.2+dfsg</code> &lt; <code>1.2.1</code>

  • tags/e/empty-rust-library-declares-provides.tag
    ... ... @@ -14,8 +14,8 @@ Explanation: For some time, Rust libraries used empty installation packages
    14 14
      .
    
    15 15
      You can see some examples here:
    
    16 16
      .
    
    17
    -     - https://sources.debian.org/src/rust-dbus/0.9.0-2/debian/control/
    
    18
    -     - https://sources.debian.org/src/rust-x11rb/0.7.0-1/debian/control/
    
    17
    +  - https://sources.debian.org/src/rust-dbus/0.9.0-2/debian/control/
    
    18
    +  - https://sources.debian.org/src/rust-x11rb/0.7.0-1/debian/control/
    
    19 19
      .
    
    20 20
      The decision to burden the Rust packaging team with that extra step was
    
    21 21
      made after weighing all possible alternatives.
    

  • tags/g/groff-message.tag
    ... ... @@ -34,6 +34,6 @@ Explanation: A manual page provoked warnings or errors from the <code>man</code>
    34 34
      .
    
    35 35
      You can see the warnings yourself by running the command used by Lintian:
    
    36 36
      .
    
    37
    -     <code>LC&lowbar;ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 \
    
    38
    -         man --warnings -E UTF-8 -l -Tutf8 -Z &lt;file&gt; &gt;/dev/null</code>
    
    37
    +     LC&lowbar;ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 \
    
    38
    +         man --warnings -E UTF-8 -l -Tutf8 -Z &lt;file&gt; &gt;/dev/null
    
    39 39
     See-Also: groff_man(7), groff_mdoc(7)

  • tags/m/missing-built-using-field-for-golang-package.tag
    ... ... @@ -11,4 +11,4 @@ Explanation: The stanza for a Golang installation package in the
    11 11
      .
    
    12 12
      Please add the following line to the relevant stanza:
    
    13 13
      .
    
    14
    -  <code>Built-Using: ${misc:Built-Using}</code>
    14
    +     Built-Using: ${misc:Built-Using}

  • tags/p/pipe-symbol-used-as-license-disjunction.tag
    1 1
     Tag: pipe-symbol-used-as-license-disjunction
    
    2 2
     Severity: warning
    
    3 3
     Check: debian/copyright/dep5
    
    4
    -Explanation: A vertical bar &vert (also known as a pipe symbol) does not stand for
    
    4
    +Explanation: A vertical bar &vert; (also known as a pipe symbol) does not stand for
    
    5 5
      a logical OR relationship in <code>debian/copyright</code>.
    
    6 6
      .
    
    7 7
      To describe dual licensing, please use the word "or" between license
    

  • tags/r/relative-library-search-path.tag
    ... ... @@ -18,9 +18,11 @@ Explanation: The binary or shared library sets RPATH or RUNPATH. This
    18 18
      .
    
    19 19
      To fix this problem, look for link lines like:
    
    20 20
      .
    
    21
    -     <code>gcc test.o -o test -Wl,--rpath,/usr/local/lib</code>
    
    21
    +     gcc test.o -o test -Wl,--rpath,/usr/local/lib
    
    22
    + .
    
    22 23
      or
    
    23
    -     <code>gcc test.o -o test -R/usr/local/lib</code>
    
    24
    + .
    
    25
    +     gcc test.o -o test -R/usr/local/lib
    
    24 26
      .
    
    25 27
      and remove the <code>-Wl,--rpath</code> or <code>-R</code> argument.
    
    26 28
      .
    

  • tags/w/whitespace-after-continuation-character.tag
    ... ... @@ -2,7 +2,7 @@ Tag: whitespace-after-continuation-character
    2 2
     Severity: error
    
    3 3
     Check: menu-format
    
    4 4
     Explanation: The menu item is split up over two or more continuation lines, but
    
    5
    - there is additional whitespace after the backslash (<code>\</code>) that
    
    5
    + there is additional whitespace after the backslash (<code>&bsol;</code>) that
    
    6 6
      indicates where lines should be joined together.
    
    7 7
      .
    
    8 8
      There is no guarantee that such additional whitespace is handled correctly.
    


  • Reply to: