All of lore.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: git@vger.kernel.org
Cc: gitster@pobox.com, Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH] Documentation/howto: tracking git.git
Date: Fri, 14 May 2021 19:49:26 +0700	[thread overview]
Message-ID: <20210514124925.39229-1-bagasdotme@gmail.com> (raw)

Document how to track git.git repository for Git development.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/Makefile                  |  1 +
 Documentation/howto/tracking-gitgit.txt | 79 +++++++++++++++++++++++++
 2 files changed, 80 insertions(+)
 create mode 100644 Documentation/howto/tracking-gitgit.txt

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 2aae4c9cbb..2b5b8b28b0 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -84,6 +84,7 @@ SP_ARTICLES += howto/rebase-from-internal-branch
 SP_ARTICLES += howto/keep-canonical-history-correct
 SP_ARTICLES += howto/maintain-git
 SP_ARTICLES += howto/coordinate-embargoed-releases
+SP_ARTICLES += howto/tracking-gitgit
 API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
 SP_ARTICLES += $(API_DOCS)
 
diff --git a/Documentation/howto/tracking-gitgit.txt b/Documentation/howto/tracking-gitgit.txt
new file mode 100644
index 0000000000..61dbd2540b
--- /dev/null
+++ b/Documentation/howto/tracking-gitgit.txt
@@ -0,0 +1,79 @@
+From: Bagas Sanjaya <bagasdotme@gmail.com>
+Date: Fri, 14 May 2021 13:26:33 +0700
+Subject: Tracking git.git
+Abstract: How to track git.git repository for Git development
+Content-type: text/asciidoc
+
+Tracking git.git
+================
+
+This short document shows how to track git.git (source code repository
+for Git) for purposes of Git development.
+
+Available Branches
+------------------
+
+There are several branches on git.git with different purposes:
+
+master::
+This is the most stable branch. Changes (topics) that are merged
+to master should have been stabilized in next and suitable for
+production use. Feature releases (vX.Y.0) are cut from this
+branch.
+
+next::
+This is where topics that haven't been yet merged to master are
+stabilized and tested for breakage and regressions. It gives
+a summary forecast of what next batch of topics that will be
+merged to master looks like.
+
+seen::
+This is the most bleeding edge branch where all excited
+developments happened. All proposed topics are queued in seen
+by the maintainer. However, these may be buggy (have breakage or
+regressions). When topics queued are deemed good and ready for
+inclusion, they are graduated to next for stabilization.
+
+maint::
+This branch is used for preparing maintenance releases. Bugfixes
+for feature release (vX.Y.0) are accumulated in maint. Then at
+some point, the tip of the branch is tagged with vX.Y.Z.
+
+todo::
+This contains helper tools written by the maintainer to ease
+maintaining Git. Also, "What's cooking in Git" messages are
+prepared in todo before being sent to the mailing list.
+
+Tracking
+--------
+
+If you don't have git.git clone handy, you can obtain one by:
+
+----
+$ git clone https://github.com/git/git.git git
+----
+
+Now you can start hacking your topics. Don't forget to read
+`Documentation/SubmittingPatches` for instructions on patch
+submission.
+
+After some time, there will be updates to git.git. First, fetch them:
+
+----
+$ git fetch origin
+----
+
+Then pull the updates.
+
+ - For `master`, `next`, `maint`, and `todo`, you can do fast-forward
+   pull:
+
+ $ git pull --ff-only
+
+ - For `seen`, DO NOT pull with `git pull`. This is because seen is
+   in constant flux, and most often your local seen is divergent from
+   the origin, caused by force-push from the maintainer. Attempting
+   to pull either via merge or rebase will most likely end in
+   conflict. Instead, pull by resetting the local seen to the origin:
+
+ $ git reset --hard origin/seen

base-commit: df6c4f722c94641d5a9ea5496511f7043433abc2
-- 
2.25.1


             reply	other threads:[~2021-05-14 12:50 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-14 12:49 Bagas Sanjaya [this message]
2021-05-14 13:49 ` [PATCH] Documentation/howto: tracking git.git Junio C Hamano
2021-05-14 15:27   ` Đoàn Trần Công Danh
2021-05-15  3:32   ` Bagas Sanjaya
2021-05-16  0:57     ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210514124925.39229-1-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.