Skip to content

Commit 0545b99

Browse files
committed
Got rid of masters and dependencies
1 parent 71342f7 commit 0545b99

3 files changed

Lines changed: 3 additions & 35 deletions

File tree

_data/navigation.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,3 @@ docs:
3535
url: /contributors/composite-builds.html
3636
- title: "Contributing"
3737
url: /contributors/contributing.html
38-
- title: "Dependencies"
39-
url: /contributors/dependencies.html

contributors/composite-builds.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ To do this, every library that depends on some other Cryptimeleon library includ
1717
This script clones the dependency to the same directory level as the library being built and includes it as a composite build if possible.
1818
"If possible" means that the branches should follow some rules. Let `LB` be the name of the branch of the library being built and `DB` be the name of the branch of the dependency library. The composite build will only be enabled if either of the following hold:
1919

20-
- The dependency has no branch called `LB` and `DB == master`. In this case, the `master` branch of the dependency is used for the composite build.
20+
- The dependency has no branch called `LB` and `DB == main`. In this case, the `main` branch of the dependency is used for the composite build.
2121
- The dependency has a branch called `LB` and `DB = LB`. In this case, the `DB` branch of the dependency is used for the composite build.
2222

23-
To summarize, the build script will always try to use the branch with the same name as `LB` and use `master` if no such branch exists.
23+
To summarize, the build script will always try to use the branch with the same name as `LB` and use `main` if no such branch exists.
2424
Importantly, no automatic checkout of branches is done.
2525
This means that if the branches don't match, the build script will complain and fail.
2626
You can adjust this behaviour using the **useCurrentBranch** parameter as explained below.
@@ -35,7 +35,7 @@ These can either be set in the `gradle.properties` file in the top level folder
3535

3636
- **useCurrentBranch**: If defined (any value) the branch selection checking will be skipped.
3737
That means the composite build will be enabled no matter the dependency branches that are currently checked out.
38-
This can be useful for when you need a version that is not on `master` but you also do not want to create a new branch.
38+
This can be useful for when you need a version that is not on `main` but you also do not want to create a new branch.
3939
- **checkoutIfCloned**: If defined (any value), will automatically check out the corresponding
4040
dependency branch (branch with same name) given that the dependency was freshly cloned.
4141
Used by the Travis CI to automatically switch to the right dependency branch for the build.

contributors/dependencies.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)