doc: Rework build-unix.md #27685

pull maflcko wants to merge 1 commits into bitcoin:master from maflcko:2305-doc-unix- changing 2 files +16 −38

maflcko commented at 11:18 AM on May 17, 2023: member
The doc has many issues:
- The fist section contains outdated non-existing and confusing configure flags like --enable-cxx and --disable-shared, as well as edge-case expert options such as BDB_PREFIX. Fix that by removing the section and adding notes elsewhere, if applicable.
- There are links to the depends system before instructions on how to simply build from system packages. Fix that by moving that later.
- Also, remove sections that are duplicate with other depends READMEs.
DrahtBot commented at 11:18 AM on May 17, 2023: contributor



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



Reviews

See the guideline for information on the review process.

Type Reviewers

ACK fanquake, TheCharlatan

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.
DrahtBot added the label Docs on May 17, 2023
DrahtBot added the label CI failed on May 17, 2023
in doc/build-unix.md:165 in fa301e9d71 outdated
```
 160 | +
 161 | +See [dependencies.md](dependencies.md) for a complete overview, and
 162 | +[depends](/depends/README.md) on how to compile them yourself, if you wish to
 163 | +not use the packages of your Linux distribution.
 164 | +
 165 |  Notes
```
fanquake commented at 12:19 PM on May 17, 2023:

While here, I think you could also remove the Notes, as well as the miniupnpc and libnatpmp sections below. I don't think Notes really adds any value, and the miniupnpc and libnatpmp sections seem irrelevant here (we also don't have a similar section for all other dependencies (nor do I think we should add one), and listing configure defaults in markdown is mostly pointless, and just duplicates the (always up to date) output of ./configure --help).

We could also remove the Security section further down, I don't think this document is the right place for generic, binary hardening information.

maflcko commented at 12:35 PM on May 17, 2023:

Thx, done

fanquake commented at 1:19 PM on May 17, 2023:

Didn't drop Security ?

maflcko commented at 1:23 PM on May 17, 2023:

Yeah, not sure if it fits in here, maybe open a separate pull for that?

fanquake commented at 1:47 PM on May 17, 2023:

Ok. Done in #27688.
fanquake commented at 12:20 PM on May 17, 2023: member

Concept ACK - build-unix probably a good candidate for being split up further at some point.
doc: Rework build-unix.md fa29651c3f
maflcko force-pushed on May 17, 2023
fanquake referenced this in commit 5b99b0feca on May 17, 2023
fanquake approved
fanquake commented at 2:33 PM on May 17, 2023: member

ACK fa29651c3ff3e13a42d6505b14971265562f088a
DrahtBot removed the label CI failed on May 17, 2023
TheCharlatan approved
TheCharlatan commented at 10:24 AM on May 18, 2023: contributor

ACK fa29651c3ff3e13a42d6505b14971265562f088a
fanquake merged this on May 18, 2023
fanquake closed this on May 18, 2023
fanquake referenced this in commit 4bfcbbfd4a on May 18, 2023
maflcko deleted the branch on May 18, 2023
sidhujag referenced this in commit ab066ede93 on May 19, 2023
fanquake referenced this in commit 17acb2782a on May 20, 2023
janus referenced this in commit fc1a725a57 on Sep 11, 2023
bitcoin locked this on May 17, 2024

Type	Reviewers
ACK	fanquake, TheCharlatan

Contributors

Labels

Linked (view graph)

#27688 doc: remove Security section from build-unix.md

doc: Rework build-unix.md #27685

Reviews