From 8a389dd253f0af6b61d8c42edfc9b3524a91f9fc Mon Sep 17 00:00:00 2001 From: Mohammad Akhlaghi Date: Sun, 15 Sep 2019 03:41:39 +0100 Subject: 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'. --- README-hacking.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'README-hacking.md') 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 -- cgit v1.2.1