Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add nice table to files.md #14914

Merged
merged 1 commit into from Dec 12, 2018

Conversation

Projects
None yet
7 participants
@emilengler
Copy link
Contributor

commented Dec 10, 2018

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

@fanquake fanquake added the Docs label Dec 10, 2018

@promag

This comment has been minimized.

Copy link
Member

commented Dec 11, 2018

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

@emilengler

This comment has been minimized.

Copy link
Contributor Author

commented Dec 11, 2018

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

@promag

This comment has been minimized.

Copy link
Member

commented Dec 11, 2018

You can remove the left and right borders.

@emilengler

This comment has been minimized.

Copy link
Contributor Author

commented Dec 11, 2018

Done @promag

@promag

This comment has been minimized.

Copy link
Member

commented Dec 11, 2018

@emilengler please squash.

doc/files.md Outdated
wallets/wallet.dat | personal wallet (BDB) with keys and transactions; since 0.16.0
.cookie | session RPC authentication cookie (written at start when cookie authentication is used, deleted on shutdown): since 0.12.0
onion_private_key | cached Tor hidden service private key for -listenonion: since 0.12.0
guisettings.ini.bak | backup of former GUI settings after -resetguisettings is used

This comment has been minimized.

Copy link
@practicalswift

practicalswift Dec 11, 2018

Member

Keep the formatting unchanged - preserve backticks :-)

This comment has been minimized.

Copy link
@emilengler

emilengler Dec 11, 2018

Author Contributor

Ok just was confused by the travis errors

@emilengler

This comment has been minimized.

Copy link
Contributor Author

commented Dec 11, 2018

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

@jonasschnelli

This comment has been minimized.

Copy link
Member

commented Dec 11, 2018

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

Show resolved Hide resolved doc/files.md Outdated
doc/files.md Outdated
wallets/wallet.dat | personal wallet (BDB) with keys and transactions; since 0.16.0
.cookie | session RPC authentication cookie (written at start when cookie authentication is used, deleted on shutdown): since 0.12.0
onion_private_key | cached Tor hidden service private key for -listenonion: since 0.12.0
guisettings.ini.bak | backup of former GUI settings after -resetguisettings is used

This comment has been minimized.

Copy link
@MarcoFalke

MarcoFalke Dec 11, 2018

Member

Should keep the backtick quotes?

This comment has been minimized.

Copy link
@emilengler

emilengler Dec 11, 2018

Author Contributor

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

@MarcoFalke

This comment has been minimized.

Copy link
Member

commented Dec 11, 2018

@emilengler

This comment has been minimized.

Copy link
Contributor Author

commented Dec 11, 2018

@MarcoFalke Done with squashing

@promag
Copy link
Member

left a comment

Almost there.

doc/files.md Outdated
wallets/db.log | wallet database log file; since 0.16.0
wallets/wallet.dat | personal wallet (BDB) with keys and transactions; since 0.16.0
.cookie | session RPC authentication cookie (written at start when cookie authentication is used, deleted on shutdown): since 0.12.0
onion_private_key | cached Tor hidden service private key for ```-listenonion```: since 0.12.0

This comment has been minimized.

Copy link
@promag

promag Dec 11, 2018

Member

Just one backtick?

blocks/blk000??.dat | block data (custom, 128 MiB per file); since 0.8.0
blocks/rev000??.dat | block undo data (custom); since 0.8.0 (format changed since pre-0.8)
blocks/index/* | block index (LevelDB); since 0.8.0
chainstate/* | blockchain state database (LevelDB); since 0.8.0

This comment has been minimized.

Copy link
@promag

promag Dec 11, 2018

Member

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

doc/files.md Outdated
wallets/wallet.dat | personal wallet (BDB) with keys and transactions; since 0.16.0
.cookie | session RPC authentication cookie (written at start when cookie authentication is used, deleted on shutdown): since 0.12.0
onion_private_key | cached Tor hidden service private key for ```-listenonion```: since 0.12.0
guisettings.ini.bak | backup of former GUI settings after ```-resetguisettings``` is used

This comment has been minimized.

Copy link
@promag

promag Dec 11, 2018

Member

Just one backtick?

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
@emilengler

This comment has been minimized.

Copy link
Contributor Author

commented Dec 11, 2018

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

@promag

This comment has been minimized.

Copy link
Member

commented Dec 11, 2018

ACK 9b51b15.

@fanquake

This comment has been minimized.

Copy link
Member

commented Dec 12, 2018

utACK 9b51b15

table

@laanwj

This comment has been minimized.

Copy link
Member

commented Dec 12, 2018

LGTM, thanks for contributing to the documentation
utACK 9b51b15

@laanwj laanwj merged commit 9b51b15 into bitcoin:master Dec 12, 2018

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

laanwj added a commit that referenced this pull request Dec 12, 2018

Merge #14914: Docs: Add nice table to files.md
9b51b15 Add nice table to files.md (Emil Engler)

Pull request description:

  I have added a nice table to the files.md in the documentation.
  This looks way more better and lightweight than before.
  [Screenshot](https://imgur.com/a/wJuQgZN)

Tree-SHA512: 0c59171531b99f3bc898108c7c570e9e8309e7011d6f3b3211b0200eb2354fd4c4211bba5950d450522523f346631e23b87201813337ed5849336d359c0e166d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.