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

doc: move gitian building to external repo #11401

Merged
merged 1 commit into from Sep 28, 2017

Conversation

maflcko
Copy link
Member

@maflcko maflcko commented Sep 25, 2017

The guide was moved to the Bitcoin Core documentation repository.

It now includes not only instructions to run on a debian host, but also on
any recent fedora host.

This is an ongoing effort to reduce the fraction caused by incoming
pull requests to docs (usually fixups, typo fixes, version bumps).

This is especially important for documentation that is independent
of any release cycles and should thus be up-to-date regardless
of a tag on a non-master branch.

Finally, fetching a shallow copy of the source is less heavy,
as many binary png files are moved out of the repo.

This reduces the overhead in the git repo due to binary blobs of
the png files.

Also, the documentation can be updated independent of any tags and
release cycles.
@maflcko maflcko added the Docs label Sep 25, 2017
@promag
Copy link
Member

promag commented Sep 25, 2017

Finally, fetching the source code of the current HEAD is less heavy, as many binary png files are moved out of the repo.

You mean downloading an archive?

@maflcko
Copy link
Member Author

maflcko commented Sep 25, 2017

Jup, or fetching with --depth specified, which will fetch a shallow copy.

@fanquake
Copy link
Member

fanquake commented Sep 26, 2017

I'm not completely in favour of this, now the instructions to reproducibly build are no longer available with the code your downloading.

I also don't really agree that these are instructions that are "independent of any release cycles". I've occasionally gone back to a historic branch, knowing that the gitian build instructions in that branch will work with that code. Separating the instructions and keeping them updated to only build the latest version of the code means that'll no longer be the case (maybe that doesn't matter).

Regardless, you'll need to update the link under Building in the main readme (dead).
You should also remove the partial gitian build instructions here (outdated).

@meshcollider
Copy link
Contributor

@fanquake note that the instructions for gitian building are still in the release-process.md, only the instructions to set up the gitian building VM is moving

@fanquake
Copy link
Member

fanquake commented Sep 26, 2017

Right, I guess I always thought of them as being the same thing. In that case, this PR should be updating some docs somewhere here to point to the new home of the guide, maybe in release-process? Otherwise anyone reading that doc gets no indication there is a whole other setup process involved. As well as changes above.

@laanwj
Copy link
Member

laanwj commented Sep 26, 2017

utACK

I agree that having a documentation repository for "heavy" guides like this is a good idea. This also this means not having to carry the images, and most importantly updates to the images in the future.

In that case, this PR should be updating some docs somewhere here to point to the new home of the guide, maybe in release-process?

The file itself contains a link to the new location. Possibly this could be extended to places that link the file, which would save a step, though I have no strong opinion about that.

@laanwj laanwj merged commit fa082b4 into bitcoin:master Sep 28, 2017
laanwj added a commit that referenced this pull request Sep 28, 2017
fa082b4 doc: move gitian building to external repo (MarcoFalke)

Pull request description:

  The guide was moved to [the Bitcoin Core documentation repository](https://github.com/bitcoin-core/docs/blob/master/gitian-building.md).

  It now includes not only instructions to run on a debian host, but also on
  any recent fedora host.

  This is an ongoing effort to reduce the fraction caused by incoming
  pull requests to docs (usually fixups, typo fixes, version bumps).

  This is especially important for documentation that is independent
  of any release cycles and should thus be up-to-date regardless
  of a tag on a non-master branch.

  Finally, fetching a shallow copy of the source is less heavy,
  as many binary png files are moved out of the repo.

Tree-SHA512: c88a11667826d44f90af41e50f9e8d5b3132ae83b278597f13be694872212e7eff99fd877feec0308e00259c69fd4e0ebaf3ff5ab45e08a1e41336aa505bb72b
laanwj added a commit that referenced this pull request Sep 29, 2017
…scriptors dir.

bb174e1 [docs] Remove partial gitian instructions from descriptors dir (fanquake)

Pull request description:

  Cleanup after #11401.

Tree-SHA512: 9378463d3dd7a3c5b41388749002aef767581de28c92c19c89cc39c4e8ec5959f91d0232c6333e440c157d448be2f686dbcc7099aedd9510e4b36807690201fc
@maflcko maflcko deleted the Mf1708-docGitianFedora branch September 29, 2017 20:19
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants