doc: Fix markdown formatting #21075

gunar commented at 5:49 PM on February 3, 2021: contributor

Lines were being joined making it hard to read.

in doc/init.md:56 in 58a1dc6b35 outdated

  52 | @@ -53,11 +53,12 @@ Paths
  53 |  
  54 |  All three configurations assume several paths that might need to be adjusted.
  55 |  
  56 | -Binary:              `/usr/bin/bitcoind`
  57 | -Configuration file:  `/etc/bitcoin/bitcoin.conf`
  58 | -Data directory:      `/var/lib/bitcoind`
  59 | -PID file:            `/var/run/bitcoind/bitcoind.pid` (OpenRC and Upstart) or `/run/bitcoind/bitcoind.pid` (systemd)
  60 | -Lock file:           `/var/lock/subsys/bitcoind` (CentOS)
  61 | +    Binary:              /usr/bin/bitcoind

RandyMcMillan commented at 6:05 PM on February 3, 2021:

Binary:              /usr/bin/bitcoind
Configuration file:  /etc/bitcoin/bitcoin.conf
Data directory:      /var/lib/bitcoind
PID file:            /var/run/bitcoind/bitcoind.pid (OpenRC and Upstart) or
                     /run/bitcoind/bitcoind.pip (systemd)
Lock file:           /var/lock/subsys/bitcoind (CentOS)

RandyMcMillan commented at 6:06 PM on February 3, 2021:

I recommend 4 spaces for indenting.

RandyMcMillan commented at 6:22 PM on February 3, 2021:

I disagree - I wish more people reviewed documentation and submitted improvements. This should be encouraged.

gunar commented at 6:49 PM on February 3, 2021:

This is the formatting I'm looking to fix (below). It's indeed my first contribution albeit small. Looking forward to making more meaningful ones as I get more comfortable with the codebase.

RandyMcMillan commented at 6:53 PM on February 3, 2021:

I have linked to some suggested changes ->

Additional suggested improvements:

https://github.com/RandyMcMillan/bitcoin-core/blob/gunar-patch-1/doc/init.md

add those..

unknown commented at 7:22 PM on February 3, 2021:

@gunar :+1: I think there should be more changes than just adding spaces. At least write something..

RandyMcMillan changes_requested

RandyMcMillan commented at 6:14 PM on February 3, 2021: contributor

Additional suggested improvements:

https://github.com/RandyMcMillan/bitcoin-core/blob/gunar-patch-1/doc/init.md

DrahtBot added the label Docs on Feb 3, 2021

promag commented at 7:24 PM on February 3, 2021: member

Could also fix https://github.com/bitcoin/bitcoin/blob/58a1dc6b355c4964a6d6b99eaa1edcc40369e104/doc/init.md#macos

Edit: @RandyMcMillan already pointed this.

gunar commented at 8:28 AM on February 4, 2021: contributor

Suggestions merged and commits squashed. Thank you.

laanwj commented at 8:34 AM on February 4, 2021: member

ACK dcab5e813348e4a01517a99e129c0a27e6224298

For next time, when you make changes aimed at formatting on the website: it's useful if you link to the rendered documents so people can easily compare. E.g.

Before: https://github.com/bitcoin/bitcoin/blob/a2a03c3ca94b1cdd279ac09f2a81e04d262586fd/doc/init.md#paths After: https://github.com/bitcoin/bitcoin/blob/dcab5e813348e4a01517a99e129c0a27e6224298/doc/init.md#paths

in doc/init.md:60 in dcab5e8133 outdated

  60 | -Lock file:           `/var/lock/subsys/bitcoind` (CentOS)
  61 | +	Binary:              /usr/bin/bitcoind
  62 | +	Configuration file:  /etc/bitcoin/bitcoin.conf
  63 | +	Data directory:      /var/lib/bitcoind
  64 | +	PID file:            /var/run/bitcoind/bitcoind.pid (OpenRC and Upstart) or
  65 | +                         /run/bitcoind/bitcoind.pip (systemd)

MarcoFalke commented at 9:09 AM on February 4, 2021:

What is the point of mixing tabs and spaces? Why is the file extension changed to pip?

gunar commented at 9:18 AM on February 4, 2021:

The file extension change was a typo. Fixed now.

Mixing tabs and spaces is what https://github.com/bitcoin/bitcoin/blob/master/doc/tor.md#L24-L27 does. Do you think we should change it everywhere?

in doc/init.md:11 in dcab5e8133 outdated

  11 | -    contrib/init/bitcoind.init:       CentOS compatible SysV style init script
  12 | +	contrib/init/bitcoind.service:    systemd service unit configuration
  13 | +	contrib/init/bitcoind.openrc:     OpenRC compatible SysV style init script
  14 | +	contrib/init/bitcoind.openrcconf: OpenRC conf.d file
  15 | +	contrib/init/bitcoind.conf:       Upstart service configuration file
  16 | +	contrib/init/bitcoind.init:       CentOS compatible SysV style init script

MarcoFalke commented at 9:10 AM on February 4, 2021:

Why is this changed?

gunar commented at 9:14 AM on February 4, 2021:

MarcoFalke commented at 9:18 AM on February 4, 2021:

That is a screenshot of the rendered changes of the second hunk. The first hunk (contrib/init) renders fine already.

gunar commented at 9:21 AM on February 4, 2021:

My bad—this is for tabs/spaces inconsistency consistency. Happy to go one way or the other.

Re: #21075 (review)

laanwj commented at 10:48 AM on February 4, 2021:

Yes, please don't use tabs. If it wasn't clear yet, we use spaces for indentation only in this project.

gunar commented at 12:08 PM on February 4, 2021:

Cool, thanks for the info. I've just replaced tabs for spaces in all other doc/*.md files too: e1604b3 (#21075)

MarcoFalke changes_requested

MarcoFalke commented at 9:10 AM on February 4, 2021: member

this changes the filename from pid to pip. why?

doc: Fix markdown formatting

Lines were being joined making it hard to read.

98db48d349

doc: Replace tabs for spaces e1604b3d50

RandyMcMillan commented at 9:17 PM on February 8, 2021: contributor

ACK e1604b3d50dca3291a432be59cfd03c0e846e7b2

This commit renders cleanly on gh-flavored md and @MacDownApp

build-unix.md before build-unix.md after

init.md before init.md after

tor.md before tor.md after

MarcoFalke merged this on Feb 9, 2021

MarcoFalke closed this on Feb 9, 2021

in doc/tor.md:52 in e1604b3d50

  76 | +                    specified multiple times to allow multiple network types, e.g.
  77 | +                    ipv4, ipv6 or onion. If you use this option with values other
  78 | +                    than onion you *cannot* disable onion connections; outgoing onion
  79 | +                    connections will be enabled when you use -proxy or -onion. Use
  80 | +                    -noonion or -onion=0 if you want to be sure there are no outbound
  81 | +                    onion connections over the default proxy or your defined -proxy.

jonatack commented at 1:34 PM on February 9, 2021:

Why were all of these changed, rather than only the lines with tabs?

FWIW I proposed to do just that in this file a few months ago and was asked not to because it was unnecessary churn.

jonatack commented at 1:34 PM on February 9, 2021:

:man_shrugging:

gunar deleted the branch on Feb 9, 2021

sidhujag referenced this in commit 1bd342dba8 on Feb 9, 2021

laanwj referenced this in commit b3dda0af0e on Feb 10, 2021

sidhujag referenced this in commit 0cfee49446 on Feb 11, 2021

PastaPastaPasta referenced this in commit 3cba474d6a on Jun 27, 2021

PastaPastaPasta referenced this in commit 64efa9ee97 on Jun 28, 2021

PastaPastaPasta referenced this in commit 4fcfb96261 on Jun 29, 2021

PastaPastaPasta referenced this in commit b70e88b420 on Jul 1, 2021

PastaPastaPasta referenced this in commit 54d505044d on Jul 1, 2021

PastaPastaPasta referenced this in commit 33b761c4ec on Jul 15, 2021

PastaPastaPasta referenced this in commit a9c314feba on Jul 16, 2021

DrahtBot locked this on Aug 18, 2022