summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNicolas Cavallari <nicolas.cavallari@green-communications.fr>2021-06-23 16:57:48 +0200
committerNicolas Cavallari <nicolas.cavallari@green-communications.fr>2021-06-23 17:47:12 +0200
commita2cd66be8a7a0da65a197eef69c4dadc9ecf7f49 (patch)
tree36189607e9284b4a1faa1ab9579ba5469075ca59 /docs
parent0d0150d8eb5fe5654af4172fe2f923f5d1317eb7 (diff)
downloadlibgit2-a2cd66be8a7a0da65a197eef69c4dadc9ecf7f49.tar.gz
docs: stop mentioning libgit2's "master" branch
The name of libgit2's main branch is now "main" but contributing.md and release.md still reference "master" as the main branch. Fix it.
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing.md8
-rw-r--r--docs/release.md6
2 files changed, 7 insertions, 7 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
index 21e42b1d9..a6eca3d15 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -35,7 +35,7 @@ easily accessible permanent record of the conversation.
## Libgit2 Versions
-The `master` branch is the main branch where development happens.
+The `main` branch is the main branch where development happens.
Releases are tagged
(e.g. [v0.21.0](https://github.com/libgit2/libgit2/releases/tag/v0.21.0) )
and when a critical bug fix needs to be backported, it will be done on a
@@ -51,7 +51,7 @@ commit SHA
Using [`git describe`](http://git-scm.com/docs/git-describe) is a
great way to tell us what version you're working with.
-If you're not running against the latest `master` branch version,
+If you're not running against the latest `main` branch version,
please compile and test against that to avoid re-reporting an issue that's
already been fixed.
@@ -68,11 +68,11 @@ flow](https://guides.github.com/introduction/flow/index.html), where
contributors fork the [libgit2 repository](https://github.com/libgit2/libgit2),
make their changes on branch, and submit a
[Pull Request](https://help.github.com/articles/using-pull-requests)
-(a.k.a. "PR"). Pull requests should usually be targeted at the `master`
+(a.k.a. "PR"). Pull requests should usually be targeted at the `main`
branch.
Life will be a lot easier for you (and us) if you follow this pattern
-(i.e. fork, named branch, submit PR). If you use your fork's `master`
+(i.e. fork, named branch, submit PR). If you use your fork's `main`
branch directly, things can get messy.
Please include a nice description of your changes when you submit your PR;
diff --git a/docs/release.md b/docs/release.md
index 22b35ede7..507d58b8a 100644
--- a/docs/release.md
+++ b/docs/release.md
@@ -1,6 +1,6 @@
# Releasing the library
-We have three kinds of releases: "full" releases, maintenance releases and security releases. Full ones release the state of the `master` branch whereas maintenance releases provide bugfixes building on top of the currently released series. Security releases are also for the current series but only contain security fixes on top of the previous release.
+We have three kinds of releases: "full" releases, maintenance releases and security releases. Full ones release the state of the `main` branch whereas maintenance releases provide bugfixes building on top of the currently released series. Security releases are also for the current series but only contain security fixes on top of the previous release.
## Full release
@@ -40,7 +40,7 @@ followed by the three sections in the changelog. For release candidates we can a
During the freeze, and certainly after the first release candidate, any bindings the core team work with should be updated in order to discover any issues that might come up with the multitude of approaches to memory management, embedding or linking.
-Create a branch `maint/v0.X` at the current state of `master` after you've created the tag. This will be used for maintenance releases and lets our dependents track the latest state of the series.
+Create a branch `maint/v0.X` at the current state of `main` after you've created the tag. This will be used for maintenance releases and lets our dependents track the latest state of the series.
## Maintenance release
@@ -76,7 +76,7 @@ We use docurium to generate our documentation. It is a tool written in ruby whic
gem install docurium
-and run it against our description file with the tip of master checked out.
+and run it against our description file with the tip of main checked out.
cm doc api.docurium