Docs: Improve build-osx document formatting #15964

pull giulio92 wants to merge 1 commits into bitcoin:master from giulio92:feature/update-macOS-doc changing 1 files +131 −132

giulio92 commented at 6:37 PM on May 6, 2019: contributor
This PR will improve build-osx.md formatting by:
1. Updating Markdown syntax to the latest one
2. Adding syntax highlighting to all code blocks
3. Aligning the text up to 80 column guideline (before it was following different guidelines, sometime 80, sometime 90, etc.)
4. Small grammar improvements here and there
DrahtBot added the label Docs on May 6, 2019
DrahtBot commented at 7:57 PM on May 6, 2019: member


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



Conflicts

Reviewers, this pull request conflicts with the following ones:
- #15441 ([doc] build: warn against spaces in working directory by Sjors)
- #10102 ([experimental] Multiprocess bitcoin by ryanofsky)
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.
giulio92 commented at 8:06 AM on May 31, 2019: contributor

Any update on this?
in doc/build-osx.md:113 in 4a8cf9589e outdated
```
 155 | +```
 156 |  
 157 | -Deterministic macOS DMG Notes
 158 | ------------------------------
 159 | +## Notes
 160 | +* Tested on OS X 10.10 Yosemite through macOS 10.13 High Sierra on 64-bit Intel
```
fanquake commented at 2:36 PM on June 3, 2019:

If we're changing this, might as well update to macOS 10.14 Mojave

giulio92 commented at 9:17 AM on June 5, 2019:

ACK, done in ae80e56
in doc/build-osx.md:115 in 4a8cf9589e outdated
```
 157 | -Deterministic macOS DMG Notes
 158 | ------------------------------
 159 | +## Notes
 160 | +* Tested on OS X 10.10 Yosemite through macOS 10.13 High Sierra on 64-bit Intel
 161 | +processors only.
 162 | +* Building with downloaded Qt binaries is not officially supported. See the notes in [#7714](https://github.com/bitcoin/bitcoin/7714)
```
fanquake commented at 2:38 PM on June 3, 2019:

Can you fix this link https://github.com/bitcoin/bitcoin/issues/7714

giulio92 commented at 9:17 AM on June 5, 2019:

I have checked the link: https://github.com/bitcoin/bitcoin/issues/7714

and it seems to work correctly, what should I do?

fanquake commented at 11:49 AM on June 5, 2019:

The link in the .md file is incorrect. It's missing /issues/.

giulio92 commented at 4:04 PM on June 11, 2019:

I think the link would work also with /bitcoin/ but I have updated it in adc6e43
fanquake commented at 2:45 PM on June 3, 2019: member

Concept ACK. Skimmed through and didn't see any incorrect changes.

Can you fixup the nits I've left inline.
Improve build-osx formatting dbd137a4ea
giulio92 commented at 3:49 PM on June 27, 2019: contributor

Any update on this?
fanquake approved
fanquake commented at 7:04 AM on June 29, 2019: member

ACK dbd137a4ea8f1b5dfc5cdc72cee99c8f8328b793 - Document reads and renders essentially the same as the current build-osx.md, with minor formatting / grammatical changes.
fanquake merged this on Jun 29, 2019
fanquake closed this on Jun 29, 2019
fanquake referenced this in commit 04710b6d8c on Jun 29, 2019

in doc/build-osx.md:115 in dbd137a4ea

 157 | -Deterministic macOS DMG Notes
 158 | ------------------------------
 159 | +## Notes
 160 | +* Tested on OS X 10.10 Yosemite through macOS 10.14 Mojave on 64-bit Intel
 161 | +processors only.
 162 | +* Building with downloaded Qt binaries is not officially supported. See the notes in [#7714](https://github.com/bitcoin/issues/7714)

MarcoFalke commented at 12:59 PM on June 29, 2019:

You changed this link to a 404

jonatack referenced this in commit 90b5c4eefb on Jun 29, 2019
fanquake referenced this in commit fd925e9b1c on Jun 30, 2019
sidhujag referenced this in commit 09e2286a00 on Jun 30, 2019
sidhujag referenced this in commit cd166ecdc1 on Jun 30, 2019
HashUnlimited referenced this in commit 0070c8613c on Aug 30, 2019
DrahtBot locked this on Dec 16, 2021

Contributors

Labels

Linked (view graph)

#16313 doc: Fix broken link in doc/build-osx.md

Docs: Improve build-osx document formatting #15964

Conflicts