[WIP] docs: improve linux tar packages #14167

pull cisba wants to merge 3 commits into bitcoin:master from cisba:fix-10746 changing 5 files +27 −4

cisba commented at 3:32 PM on September 7, 2018: contributor

- README.md main file placed inside share/doc/bitcoin lsb directory
- Updated README.md to include link to repo, files list and description
- Added example bitcoin.conf, init files for daemon, RPCAuth Tool

This fixes [#8160](/github-metadata-backup-bitcoin-bitcoin/8160/) (partially), fixes [#8161](/github-metadata-backup-bitcoin-bitcoin/8161/), supersedes [#14026](/github-metadata-backup-bitcoin-bitcoin/14026/), related also to [#11971](/github-metadata-backup-bitcoin-bitcoin/11971/) and [#14022](/github-metadata-backup-bitcoin-bitcoin/14022/)

docs: improve linux tar packages

    - README.md main file placed inside share/doc/bitcoin lsb directory
    - Updated README.md to include link to repo, files list and description
    - Added example bitcoin.conf, init files for daemon, RPCAuth Tool

    This fixes #8160 (partially), fixes #8161, see also PR #11971 and #14022

af69cb2d70

cisba cross-referenced this on Sep 7, 2018 from issue docs: updated README.md to include link to repo, files list and description by cisba
cisba renamed this:
~~docs: improve linux tar packages~~
docs: [WIP untested] improve linux tar packages
on Sep 7, 2018
jonasschnelli added the label Docs on Sep 7, 2018
fanquake renamed this:
~~docs: [WIP untested] improve linux tar packages~~
[WIP] docs: improve linux tar packages
on Sep 8, 2018
randolf approved

in contrib/gitian-descriptors/gitian-linux.yml:188 in af69cb2d70 outdated

 180 | @@ -181,9 +181,15 @@ script: |
 181 |      rm -rf ${DISTNAME}/lib/pkgconfig
 182 |      find ${DISTNAME}/bin -type f -executable -exec ../contrib/devtools/split-debug.sh {} {} {}.dbg \;
 183 |      find ${DISTNAME}/lib -type f -exec ../contrib/devtools/split-debug.sh {} {} {}.dbg \;
 184 | -    cp ../doc/README.md ${DISTNAME}/
 185 |      find ${DISTNAME} -not -name "*.dbg" | sort | tar --no-recursion --mode='u+rw,go+r-w,a+X' --owner=0 --group=0 -c -T - | gzip -9n > ${OUTDIR}/${DISTNAME}-${i}.tar.gz
 186 |      find ${DISTNAME} -name "*.dbg" | sort | tar --no-recursion --mode='u+rw,go+r-w,a+X' --owner=0 --group=0 -c -T - | gzip -9n > ${OUTDIR}/${DISTNAME}-${i}-debug.tar.gz
 187 | +    DOCDISTNAME="${DISTNAME}/share/doc/bitcoin"
 188 | +    mkdir -p ${DOCDISTNAME}/init
 189 | +    cp ../doc/README.md ${DOCDISTNAME}

laanwj commented at 4:51 PM on September 10, 2018:

I think the goal of putting the README.md in the root was to make it easy to find for someone extracting it

If you move it to share/doc/bitcoin, well, you might as well make it part of the general make install logic in the build system.

DocOBITCOIN approved
Merge branch 'master' into fix-10746 69eca482e8
doc/README.md included in make install logic 04de84db88
bitcoin deleted a comment on Jan 4, 2019
fanquake commented at 10:33 AM on January 4, 2019: member

@cisba What's the status of this PR, is it still a work in progress? Can you squash to remove the merge commits.
fanquake added the label Up for grabs on Jan 5, 2019
fanquake commented at 6:16 AM on January 5, 2019: member

Closing "Up for grabs". Comment if you'd like this re-opened.
fanquake closed this on Jan 5, 2019
cisba commented at 11:24 AM on February 16, 2019: contributor

@cisba What's the status of this PR, is it still a work in progress? Can you squash to remove the merge commits.

Hi @fanquake , I restarted working to this issue with automake to include the documentation in the "make install" logic

The squash you required is done on my branch
cisba commented at 11:25 AM on February 16, 2019: contributor

Closing "Up for grabs". Comment if you'd like this re-opened.

I committed changes. Now it needs review.

Sorry for delay. Family and job came first. :)
cisba commented at 7:24 PM on March 5, 2019: contributor

Please @fanquake re-open it. Thanks
MarcoFalke commented at 7:30 PM on March 5, 2019: member

@cisba just open a fresh pull request. This one cannot be reopened because the branch has been rewritten (force-pushed)
MarcoFalke removed the label Up for grabs on Mar 5, 2019
cisba referenced this in commit ad84cf876d on Mar 7, 2019
cisba referenced this in commit 9a4e593a60 on Mar 7, 2019
cisba cross-referenced this on Mar 7, 2019 from issue docs: binary tar improvement by cisba
cisba commented at 12:26 PM on March 7, 2019: contributor

@cisba just open a fresh pull request. This one cannot be reopened because the branch has been rewritten (force-pushed) Done with PR ~~#15554~~ #15569
cisba referenced this in commit 695f0a9dac on Mar 7, 2019
cisba referenced this in commit a9a124d63e on Mar 9, 2019
cisba cross-referenced this on Mar 9, 2019 from issue docs: improve linux tar packages by cisba
bitcoin locked this on Dec 16, 2021

Contributors

Labels

Linked (view graph)

#8160 Binary release tarballs should come with a README #8161 Binary release doesn't make it easy to find the source code #11971 [docs]: include README with binary releases #14022 [Docs]: new README_unix.md to be included into tar or zip archives, c…#14026 docs: updated README.md to include link to repo, files list and description #15554 docs: binary tar improvement #15569 docs: improve linux tar packages