[Aptitude-devel] Bug#776789: aptitude-doc-en: Inconsistent documentation about --show-summary's configuration option: Aptitude::CmdLine::Show-Summary vs Aptitude::CmdLine::Why-Display-Mode

[Manuel A. Fernandez Montecelo]

Control: tags -1 + pending


2015-02-01 18:39 Axel Beckert:
>Package: aptitude-doc-en
>Version: 0.6.11-1
>Severity: minor
>Usertags: found-during-book-writing
>
>Hi,
>
>in the man page aptitude(8), there is written for --show-summary:
>
>  This option corresponds to the configuration item
>  Aptitude::CmdLine::Show-Summary; if --show-summary is present on the
>  command-line, it will override Aptitude::CmdLine::Show-Summary.
>
>Looking at the version of the man page included in aptitude-doc-en,
>e.g. at
>https://aptitude.alioth.debian.org/doc/en/rn01re01.html#cmdlineOptionShowSummary
>and clicking on the link labeled "Aptitude::CmdLine::Show-Summary", I
>get to
>https://aptitude.alioth.debian.org/doc/en/ch02s05s05.html#configCmdLine-Show-Summary
>
>But the option to which the browser jumped is not
>Aptitude::CmdLine::Show-Summary but Option:
>Aptitude::CmdLine::Why-Display-Mode. Excerpt from the HTML code of that page
>
><a name="configCmdLine-Show-Summary"></a>
><div class="seg"><strong><span class="segtitle">Option: </span></strong>
><code class="literal">Aptitude::CmdLine::Why-Display-Mode</code></div>
>
>Looks as if either of these two options has been renamed in the past and
>this inconsistency has been overseen when the renaming was done.

Thanks.  Fixed (renamed Why-Display-Mode to Show-Summary), commited and
marked as +pending.

-- 
Manuel A. Fernandez Montecelo <manuel.montezelo at gmail.com>