aboutsummaryrefslogtreecommitdiff
path: root/README-hacking.md
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2019-09-15 03:41:39 +0100
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2019-09-15 03:41:39 +0100
commit8a389dd253f0af6b61d8c42edfc9b3524a91f9fc (patch)
treec3b8c84b7a197db3d101c147c7efd654c3c45d10 /README-hacking.md
parented5ef2e19658f21349cff3445fd65825277afe1b (diff)
Added tip on bundling Git history in one file
When you want to publish your project, it is very convenient to have a single file that contains the whole history. So a tip is added to `README-hacking.md' that describes how to do this with `git bundle'.
Diffstat (limited to 'README-hacking.md')
-rw-r--r--README-hacking.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README-hacking.md b/README-hacking.md
index fac9876..1893dc9 100644
--- a/README-hacking.md
+++ b/README-hacking.md
@@ -1043,6 +1043,30 @@ for the benefit of others.
[reproducible-paper-output](https://gitlab.com/makhlaghi/reproducible-paper-output)
repository.
+ - *Full Git history in one file*: When you are publishing your project
+ (for example to Zenodo for long term preservation), it is more
+ convenient to have the whole project's Git history into one file to
+ save with your datasets. Afterall, you can't be sure that your
+ current Git server (for example Gitlab, Github, or Bitbucket) will be
+ active for ever. You can't rely on them for archival
+ purposes. Fortunately keeping your whole history in one file is easy
+ with Git using the following commands. To learn more about it, run
+ `git help bundle`.
+
+ - "bundle" your project's history into one file:
+
+ ```shell
+ $ git bundle create my-project-git.bundle --all
+ ```
+
+ - You now have one file with the whole history that you can easily
+ upload anywhere. Later, if you need to unbundle it, you can use
+ the following command.
+
+ ```shell
+ $ git clone my-project-git.bundle
+ ```
+
- **Inspecting software building status**: When you run `./project
configure`, several programs and libraries start to get configured and
build (in many cases, simultaneously). To understand the building