Docs: Add nice table to files.md #14914

emilengler commented at 5:42 PM on December 10, 2018: contributor

I have added a nice table to the files.md in the documentation. This looks way more better and lightweight than before. Screenshot

fanquake added the label Docs on Dec 10, 2018

promag commented at 1:38 AM on December 11, 2018: member

What is the goal here? Have a nice table in the console or in a markdown renderer?

emilengler commented at 1:24 PM on December 11, 2018: contributor

It looks nice in a console window but also in a markdown renderer. The current file looks very crowded

promag commented at 1:29 PM on December 11, 2018: member

You can remove the left and right borders.

emilengler commented at 1:38 PM on December 11, 2018: contributor

Done @promag

promag commented at 2:45 PM on December 11, 2018: member

@emilengler please squash.

in doc/files.md:23 in 88cf5a0ea8 outdated

  54 | +wallets/database/*  | BDB database environment; used for wallets since 0.16.0                                                                    

  55 | +wallets/db.log      | wallet database log file; since 0.16.0                                                                                     

  56 | +wallets/wallet.dat  | personal wallet (BDB) with keys and transactions; since 0.16.0                                                             

  57 | +.cookie             | session RPC authentication cookie (written at start when cookie authentication is used, deleted on shutdown): since 0.12.0 

  58 | +onion_private_key   | cached Tor hidden service private key for -listenonion: since 0.12.0                                                       

  59 | +guisettings.ini.bak | backup of former GUI settings after -resetguisettings is used

practicalswift commented at 3:19 PM on December 11, 2018:

Keep the formatting unchanged - preserve backticks :-)

emilengler commented at 5:53 PM on December 11, 2018:

Ok just was confused by the travis errors

emilengler commented at 6:01 PM on December 11, 2018: contributor

@promag Should be fine now :) GitHub still displays there are 5 commits. If you click on that you will see only one

jonasschnelli commented at 6:56 PM on December 11, 2018: contributor

I guess you need to fix the trailing whitespaces... otherwise this looks good.

in doc/files.md:23 in 97999f5c0f outdated

  40 | +wallets/database/*  | BDB database environment; used for wallets since 0.16.0                                                                    
  41 | +wallets/db.log      | wallet database log file; since 0.16.0                                                                                     
  42 | +wallets/wallet.dat  | personal wallet (BDB) with keys and transactions; since 0.16.0                                                             
  43 | +.cookie             | session RPC authentication cookie (written at start when cookie authentication is used, deleted on shutdown): since 0.12.0 
  44 | +onion_private_key   | cached Tor hidden service private key for -listenonion: since 0.12.0                                                       
  45 | +guisettings.ini.bak | backup of former GUI settings after -resetguisettings is used

MarcoFalke commented at 7:15 PM on December 11, 2018:

Need to remove the trailing spaces here and in all other lines

emilengler commented at 7:32 PM on December 11, 2018:

I think I'm done now, I've fixed the trailing spaces.

in doc/files.md:23 in 89bbe58a0c outdated

  40 | +wallets/database/*  | BDB database environment; used for wallets since 0.16.0
  41 | +wallets/db.log      | wallet database log file; since 0.16.0
  42 | +wallets/wallet.dat  | personal wallet (BDB) with keys and transactions; since 0.16.0
  43 | +.cookie             | session RPC authentication cookie (written at start when cookie authentication is used, deleted on shutdown): since 0.12.0
  44 | +onion_private_key   | cached Tor hidden service private key for -listenonion: since 0.12.0
  45 | +guisettings.ini.bak | backup of former GUI settings after -resetguisettings is used

MarcoFalke commented at 7:54 PM on December 11, 2018:

Should keep the backtick quotes?

emilengler commented at 8:03 PM on December 11, 2018:

I have re-added them. Should I squash before (a possible ) merge ?

MarcoFalke commented at 8:20 PM on December 11, 2018: member

Please squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits

emilengler commented at 8:54 PM on December 11, 2018: contributor

@MarcoFalke Done with squashing

in doc/files.md:22 in 1259398dfc outdated

  39 | +wallet.dat          | personal wallet (BDB) with keys and transactions; moved to wallets/ directory on new installs since 0.16.0
  40 | +wallets/database/*  | BDB database environment; used for wallets since 0.16.0
  41 | +wallets/db.log      | wallet database log file; since 0.16.0
  42 | +wallets/wallet.dat  | personal wallet (BDB) with keys and transactions; since 0.16.0
  43 | +.cookie             | session RPC authentication cookie (written at start when cookie authentication is used, deleted on shutdown): since 0.12.0
  44 | +onion_private_key   | cached Tor hidden service private key for ```-listenonion```: since 0.12.0

promag commented at 9:03 PM on December 11, 2018:

Just one backtick?

in doc/files.md:9 in 1259398dfc outdated

  26 | +bitcoin.conf        | contains configuration settings for bitcoind or bitcoin-qt
  27 | +bitcoind.pid        | stores the process id of bitcoind while running
  28 | +blocks/blk000??.dat | block data (custom, 128 MiB per file); since 0.8.0
  29 | +blocks/rev000??.dat | block undo data (custom); since 0.8.0 (format changed since pre-0.8)
  30 | +blocks/index/*      | block index (LevelDB); since 0.8.0
  31 | +chainstate/*        | blockchain state database (LevelDB); since 0.8.0

promag commented at 9:06 PM on December 11, 2018:

"blockchain" more frequent than "block chain" so ACK.

in doc/files.md:23 in 1259398dfc outdated

  40 | +wallets/database/*  | BDB database environment; used for wallets since 0.16.0
  41 | +wallets/db.log      | wallet database log file; since 0.16.0
  42 | +wallets/wallet.dat  | personal wallet (BDB) with keys and transactions; since 0.16.0
  43 | +.cookie             | session RPC authentication cookie (written at start when cookie authentication is used, deleted on shutdown): since 0.12.0
  44 | +onion_private_key   | cached Tor hidden service private key for ```-listenonion```: since 0.12.0
  45 | +guisettings.ini.bak | backup of former GUI settings after ```-resetguisettings``` is used

promag commented at 9:07 PM on December 11, 2018:

Just one backtick?

promag commented at 9:07 PM on December 11, 2018: member

Almost there.

Add nice table to files.md

Update files.md

Fix linting issue

Return to unix line endings

Update files.md

Fix trailing whitespaces

Add backtick quotes

Just one backtick

9b51b158fc

emilengler commented at 9:25 PM on December 11, 2018: contributor

@promag I changed to one backtick and squashed the commit.

promag commented at 9:37 PM on December 11, 2018: member

ACK 9b51b15.

fanquake commented at 4:25 PM on December 12, 2018: member

utACK 9b51b15

table

laanwj commented at 5:06 PM on December 12, 2018: member

LGTM, thanks for contributing to the documentation utACK 9b51b158fc42f2d5ad4fe161053e44e667d42fd6

laanwj merged this on Dec 12, 2018

laanwj closed this on Dec 12, 2018

laanwj referenced this in commit 38fb1b40df on Dec 12, 2018

MarcoFalke locked this on Sep 8, 2021