doc: Fix whitespace errs in .md files, bitcoin.conf, and Info.plist.in #16812

pull ch4ot1c wants to merge 1 commits into bitcoin:master from ch4ot1c:docs/lint-markdown changing 10 files +27 −27
  1. ch4ot1c commented at 11:47 PM on September 5, 2019: contributor

    Although there is an existing test/lint/lint-whitespace.sh linter, it only prevents new errors from being introduced. This commit removes all existing whitespace errors from Core markdown files (skips src/crypto/ctaes/, leveldb/, and doc/release-notes/), bitcoin.conf, and Info.plist.in.

    Further formatting could be done on the markdown documents, but seeing as there several coexisting styles that break a few markdownlint rules, a first step would be to define and add a linter to Travis. For now, the small fix is made.

  2. GChuf commented at 11:56 PM on September 5, 2019: contributor

    Concept ACK

  3. DrahtBot added the label Build system on Sep 6, 2019
  4. DrahtBot added the label Docs on Sep 6, 2019
  5. DrahtBot added the label Scripts and tools on Sep 6, 2019
  6. in doc/REST-interface.md:84 in 9fc32e217c outdated
      80 | @@ -81,7 +81,7 @@ $ curl localhost:18332/rest/getutxos/checkmempool/b2cdfd7b89def827ff8af7cd9bff76
      81 |        {
      82 |           "txvers" : 1
      83 |           "height" : 2147483647,
      84 | -         "value" : 8.8687,		 
      85 | +         "value" : 8.8687,		
    


    promag commented at 1:01 AM on September 6, 2019:

    :eyes:

  7. fanquake removed the label Build system on Sep 6, 2019
  8. ch4ot1c force-pushed on Sep 6, 2019
  9. DrahtBot commented at 4:41 AM on September 6, 2019: member

    <!--e57a25ab6845829454e8d69fc972939a-->

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    <!--174a7506f384e20aa4161008e828411d-->

    Conflicts

    Reviewers, this pull request conflicts with the following ones:

    • #16392 (WIP build: macOS toolchain update by fanquake)

    If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

  10. fanquake commented at 8:18 AM on September 6, 2019: member

    The script doesn't run on Travis:

    Running script for: ac5b890fb1b05fc2d8df7e876fa94d045bf6fbc0
    shopt -s globstar
    sed -i 's/[ 	]*$//g' {build_msvc,ci,contrib,depends,test}/*.md doc/*.{md,txt} contrib/**/*.{md,txt} share/**/*.{conf,plist.in,md} test/**/*.md
    test/lint/commit-script-check.sh: 1: eval: shopt: not found
    sed: can't read {build_msvc,ci,contrib,depends,test}/*.md: No such file or directory
    sed: can't read doc/*.{md,txt}: No such file or directory
    sed: can't read contrib/**/*.{md,txt}: No such file or directory
    sed: can't read share/**/*.{conf,plist.in,md}: No such file or directory
    
  11. ch4ot1c force-pushed on Sep 6, 2019
  12. ch4ot1c force-pushed on Sep 6, 2019
  13. ch4ot1c force-pushed on Sep 6, 2019
  14. ch4ot1c force-pushed on Sep 7, 2019
  15. ch4ot1c force-pushed on Sep 8, 2019
  16. ch4ot1c commented at 4:07 AM on September 8, 2019: contributor

    For some reason, the script is skipping build-aux/ in Travis, which accounts for a single correction. I've tried it with and without both quotes and escaped dash. It runs correctly on all my linux environments - is there a bashism I'm missing?

    Could remove the touch to the .m4 file, instead, but it would be nice to get this scripted-diff working. Inspired by @promag's https://github.com/bitcoin/bitcoin/commit/12dd1013454a3b4913e8e6bbac251887e7e82ff0

    Edit: Final script was:

    -BEGIN VERIFY SCRIPT-
    sed -i -r 's/[ \t]*$//g' \
    $(git grep -IlE '[ \t]*$' -- \
    build_msvc/*.{md,in,sln,vcxproj} \
    "build-aux"/m4/*.m4 \
    ci/*.md \
    ci/**/*.md \
    contrib/*.{"bash-completion",md,pro,supp} \
    contrib/**/*.{cfg,in,md,plist,scm,txt,yml} \
    depends/*.{md,mk} \
    depends/**/*.{md,mk} \
    doc/*.{in,md,txt} \
    share/*.in \
    share/**/*.{conf,in,md,txt} \
    src/**/*.md \
    test/*.md \
    test/**/*.{in,md} \
    ':!src/crypto/ctaes' \
    ':!src/leveldb' \
    ':!src/secp256k1' \
    ':!src/univalue' \
    )
    -END VERIFY SCRIPT-
    
  17. promag commented at 10:22 PM on September 15, 2019: member

    Concept ACK.

  18. fanquake commented at 8:25 AM on September 16, 2019: member

    To be honest I'm not really concerned about the scripted diff here. A single commit that removes the last of the (impossible to re-introduce) whitespace should be fine.

  19. practicalswift commented at 3:07 PM on September 16, 2019: contributor

    ACK 48cef93ea1ca59f55f001c2c3ea122280bb05e0f -- diff looks correct

  20. MarcoFalke commented at 3:49 PM on September 16, 2019: member

    Can the scripted diff be removed, then?

  21. doc: Fix whitespace errs in .md files, bitcoin.conf, Info.plist.in, and find_bdb48.m4 6aab7649d3
  22. ch4ot1c force-pushed on Sep 17, 2019
  23. ch4ot1c commented at 8:26 AM on September 17, 2019: contributor

    Removed.

  24. fanquake approved
  25. fanquake commented at 8:34 AM on September 17, 2019: member

    ACK 6aab7649d30b19d136a27f1287fd2c8b00fb460c - Thanks for following up. Hopefully we now never have to deal with whitespace again.

  26. fanquake referenced this in commit f18a9065e9 on Sep 17, 2019
  27. fanquake merged this on Sep 17, 2019
  28. fanquake closed this on Sep 17, 2019

  29. Munkybooty referenced this in commit 9f052daa3a on Dec 7, 2021
  30. Munkybooty referenced this in commit 0723582eae on Dec 15, 2021
  31. Munkybooty referenced this in commit 939fd283d7 on Dec 15, 2021
  32. MarcoFalke locked this on Dec 16, 2021

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-22 18:14 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me