gergely/taskwarrior-2.x
1
0
Fork 0
Code Issues Actions Packages Projects Releases 1 Wiki Activity

fix branch references in dev docs

Browse Source
This commit is contained in:
Dustin J. Mitchell
2023-04-08 08:59:44 -04:00
committed by Dustin J. Mitchell
parent 491941a55c
commit ed674ec9e5
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/contrib/build.md
View File

@@ -28,23 +28,24 @@ Specifically the development versions, `uuid-dev` on Debian, for example.
$ git clone https://github.com/GothenburgBitFactory/taskwarrior.git taskwarrior.git $ git clone https://github.com/GothenburgBitFactory/taskwarrior.git taskwarrior.git
# Building the Stable Version # Building the Development Version
The master always represents the more recently released version, and should be The `develop` branch always represents the latest, unreleased version.
your preferred choice.
$ cd taskwarrior.git $ cd taskwarrior.git
$ git checkout master # Master is the stable branch. $ git checkout develop
$ git submodule init # Register submodule
$ git submodule update # Get the submodule
$ cmake -DCMAKE_BUILD_TYPE=release . # 'release' for performance. $ cmake -DCMAKE_BUILD_TYPE=release . # 'release' for performance.
$ make # Just build it. $ make # Just build it.
# Building the Dev Branch # Building the Stable Version
The dev branch is always the highest numbered branch, in this example, `2.6.0`. Releases are tagged. Choose the latest release version, instead of 2.6.0 below.
$ cd taskwarrior.git $ cd taskwarrior.git
$ git checkout 2.6.0 # Dev branch $ git checkout v2.6.0 # Release tag
$ git submodule init # Register submodule $ git submodule init # Register submodule
$ git submodule update # Get the submodule $ git submodule update # Get the submodule
$ cmake -DCMAKE_BUILD_TYPE=debug . # debug or release, default: neither $ cmake -DCMAKE_BUILD_TYPE=debug . # debug or release, default: neither
@@ -69,7 +70,7 @@ In particular, the [vramsteg](https://gothenburgbitfactory.org/projects/vramsteg
Talk to us first - make sure you are working on something that is wanted. Talk to us first - make sure you are working on something that is wanted.
Patches will not be applied simply because you did the work. Patches will not be applied simply because you did the work.
Remember the various forms of documentation involved, and the test suite. Remember the various forms of documentation involved, and the test suite.
Work on the dev branch, not `master`. Work on the `develop` branch, not `master`.
When you are are ready to submit, do this: When you are are ready to submit, do this:
$ git commit $ git commit