Skip to content

Commit 32293e2

Browse files
gastmaiernunojsa
authored andcommitted
docs: contribute: Suggest checking-out tags
To avoid unnecessary conflicts on pull and merge, suggest developers to checkout tags, even when targeting mirror_ci/ branches. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
1 parent fee7de5 commit 32293e2

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

docs/ci.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,13 @@ provided (``mirror_ci/<remote-name>/<branch>``):
4444
4545
When upstreaming a driver, target the pull-request against the mirror.
4646

47+
.. attention::
48+
49+
Do **not** base your work on the head of the ``mirror_ci/*``, it is
50+
frequently force pushed either by upstream (they are testing branches after
51+
all). Instead, find a common stable base, for example the previous tag such
52+
as `v6.19-rc1 <https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?h=v6.19-rc1&id=8f0b4cce4481fb22653697cced8d0d04027cb1e8>`__
53+
4754
All of them are mirrors from the links shown with a single commit on top
4855
that includes the CI workflows, :git-linux:`as simple as <ci:.github/workflows/mirror.yml>`:
4956

docs/contribute.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,16 @@ conventions, and lifecycle, helping maintain modularity and clarity. For an
175175
up-to-date map of these subsystems and their interfaces, see
176176
:external+upstream:doc:`subsystem-apis`.
177177

178+
When developing for a particular subsystem, look for the appropriate git tree
179+
in the :git-linux:`MAINTAINERS` file to work on. Development branches may be
180+
force pushed. It is reasonable to base you work on top of the current latest
181+
tag, such as `v6.19-rc1
182+
<https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?h=v6.19-rc1&id=8f0b4cce4481fb22653697cced8d0d04027cb1e8>`__
183+
or near it, this avoids unnecessary merge commits when pulling changes.
184+
185+
For some subsystems, CI/CD is automatically applied to developemnt branches as
186+
described at :ref:`ci`.
187+
178188
IIO Subsytem
179189
~~~~~~~~~~~~
180190

0 commit comments

Comments
 (0)