Wireshark-commits: [Wireshark-commits] master 68698db: Always use html2text.py for FAQ, improve out
Date Index · Thread Index · Other Months · All Mailing Lists
Date Prev · Date Next · Thread Prev · Thread Next
From: Wireshark code review <code-review-do-not-reply@xxxxxxxxxxxxx>
Date: Wed, 25 Mar 2015 07:08:56 +0000 (UTC)
URL: https://code.wireshark.org/review/gitweb?p=wireshark.git;a=commit;h=68698db8ccec8733929752c4b13da71dcad6213e
Submitter: Anders Broman (a.broman58@xxxxxxxxx)
Changed: branch: master
Repository: wireshark

Commits:

68698db by Peter Wu (peter@xxxxxxxxxxxxx):

    Always use html2text.py for FAQ, improve output
    
    A recent commit broke compilation with Python 3. The original author of
    html2text.py is deceased and the fork has increased the number of files
    for this "simple" helper.
    
    The html2text.py script in this patch was rewritten and its output
    matches with lynx (except for a few newlines around lists). This means
    that indentation has been added for headings, paragraphs and lists.
    Also, since it was written from scratch, a new license could be chosen
    that matches Wireshark.
    
    Since now the in-tree html2text.py script provides nicer output, remove
    detection of the alternative programs (elinks, links). lynx/w3m is
    somehow still necessary for asciidoc though.
    
    (I also looked into reusing html2text.py for the release notes to
    replace asciidoc, but the --format=html output produces different output
    (HTML adds a ToC and section numbers). For now still require lynx for
    release notes)
    
    Tested with Python 2.6.6, 2.7.9, 3.2.6 and 3.4.3 under LC_ALL=C and
    LC_ALL=en_US.UTF-8 on Linux. Tested reading from stdin and file, writing
    to file, pipe and tty. Tested with cmake (Ninja) and autotools on Arch
    Linux x86_64. Test:
    
        # For each $PATH per python version, execute (with varying LC_ALL)
        help/faq.py -b | tools/html2text.py /dev/stdin | md5sum
        help/faq.py -b | tools/html2text.py | md5sum
        help/faq.py -b | tools/html2text.py
        help/faq.py -b | tools/html2text.py >/dev/null
    
    Change-Id: I6409450a3e6c8b010ca082251f9db7358b0cc2fd
    Reviewed-on: https://code.wireshark.org/review/7779
    Petri-Dish: Peter Wu <peter@xxxxxxxxxxxxx>
    Tested-by: Petri Dish Buildbot <buildbot-no-reply@xxxxxxxxxxxxx>
    Reviewed-by: Anders Broman <a.broman58@xxxxxxxxx>
    

Actions performed:

    from  83b6338   faq: fix formatting, fix links, use HTML5
    adds  68698db   Always use html2text.py for FAQ, improve output


Summary of changes:
 CMakeLists.txt               |    5 +-
 COPYING                      |    1 -
 cmake/modules/FindLYNX.cmake |   20 +-
 config.nmake                 |   14 +-
 configure.ac                 |   12 +-
 docbook/Makefile.am          |   20 --
 help/Makefile.am             |   11 +-
 help/Makefile.nmake          |    2 +-
 tools/checklicenses.py       |    3 -
 tools/html2text.py           |  652 ++++++++++--------------------------------
 10 files changed, 171 insertions(+), 569 deletions(-)