Skip to content

Commit 582cb01

Browse files
committed
btrfs-progs: docs: update source repositories, workflows
[ci skip] Signed-off-by: David Sterba <dsterba@suse.com>
1 parent e4cacb4 commit 582cb01

File tree

2 files changed

+25
-33
lines changed

2 files changed

+25
-33
lines changed

Documentation/Source-repositories.rst

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,13 @@ integration:
1717
* branch `next-fixes <https://git.kernel.org/pub/scm/linux/kernel/git/kdave/linux.git/log/?h=next-fixes>`__
1818
has fixes for the next upcoming *rcN* and is usually turned into a pull request
1919

20-
The following git repositories are used for development and are updated with
20+
The following git repository is used for group development and is updated with
2121
patches from the mailing list:
2222

23-
* https://github.com/kdave/btrfs-devel
24-
* https://gitlab.com/kdave/btrfs-devel
23+
* https://github.com/btrfs/linux
2524

26-
Branches are usually pushed to both repositories, either can be used.
27-
28-
There are:
29-
30-
* `misc-next <https://github.com/kdave/btrfs-devel/tree/misc-next>`_) -
31-
main queue with patches for next development cycle, this branch is usually
32-
based on the last *rcN* tag of Linus' git tree
33-
* e.g. *for-4.15* or *misc-4.15* - queue with patches for current release cycle,
34-
the version changes
35-
* topic branches, e.g. from a patchset picked from mailing list
36-
* snapshots of `for-next <https://github.com/kdave/btrfs-devel/tree/for-next>`_,
37-
that contain all of the above (e.g. for-next-20200512)
38-
39-
Note that the branches get rebased or updated (fixed typos, added Reviewed-by
25+
The main branch with patches is `for-next <https://github.com/btrfs/linux/tree/for-next>`__ .
26+
Note that it gets rebased or updated (fixed typos, added Reviewed-by
4027
tags etc). The base point for patches depend on the development phase. See
4128
:ref:`development schedule<devfaq-development-schedule>`. Independent changes
4229
can be based on the *linus/master* branch, changes that could depend on patches
@@ -45,18 +32,20 @@ that have been added to one of the queues should use that as a base.
4532
btrfs-progs git repository
4633
--------------------------
4734

48-
Official repositories
49-
^^^^^^^^^^^^^^^^^^^^^
35+
Release repositories
36+
^^^^^^^^^^^^^^^^^^^^
5037

5138
The sources of the userspace utilities can be obtained from these repositories:
5239

5340
* git://git.kernel.org/pub/scm/linux/kernel/git/kdave/btrfs-progs.git
5441
(`<http://git.kernel.org/?p=linux/kernel/git/kdave/btrfs-progs.git;a=summary>`__)
5542
- release repository, not for development
5643

57-
The **master** branch contains the latest released version and is never rebased.
44+
The **master** branch contains the latest released version is never rebased and
45+
updated after a release.
5846

59-
Development git repositories:
47+
Development repositories
48+
^^^^^^^^^^^^^^^^^^^^^^^^
6049

6150
* git://github.com/kdave/btrfs-progs.git (`<https://github.com/kdave/btrfs-progs>`__)
6251
* git://gitlab.com/kdave/btrfs-progs.git (`<https://gitlab.com/kdave/btrfs-progs>`__)
@@ -74,16 +63,18 @@ added to the branch, a mail notification is sent as a reply to the patch.
7463
The git repositories on *kernel.org* are not used for development or
7564
integration branches.
7665

77-
Note to GitHub users
78-
^^^^^^^^^^^^^^^^^^^^
66+
GitHub development
67+
^^^^^^^^^^^^^^^^^^
68+
69+
Pull requests are accepted for contributions, and slightly more preferred as
70+
they get tested by the CI (Github actions). Patches to the mailing are also
71+
accepted but not mandatory. You can link to a branch in any git repository if
72+
the mails do not make it to the mailing list or for convenience.
7973

80-
The pull requests will not be accepted directly, the preferred way is to send
81-
patches to the mailing list instead. You can link to a branch in any git
82-
repository if the mails do not make it to the mailing list or for convenience.
74+
The development model of btrfs-progs has moved from kernel model to
75+
github and is less strict about some things. :doc:`dev/GithubReviewWorkflow`.
8376

84-
The development model of btrfs-progs shares a lot with the kernel model. The
85-
github.com way is different in some ways. We, the upstream community, expect that
86-
the patches meet some criteria (often lacking in github.com contributions):
77+
It is still desired to write good changelogs:
8778

8879
* proper **subject line**: e.g. prefix with *btrfs-progs: subpart, ...* ,
8980
descriptive yet not too long
@@ -97,6 +88,10 @@ the patches meet some criteria (often lacking in github.com contributions):
9788
* **one logical change** per patch: e.g. not mixing bug fixes, cleanups,
9889
features etc., sometimes it's not clear and will be usually pointed out
9990
during reviews
91+
* references to reports, issues, pull requests
92+
93+
Pull requests allow to update commits, fixups are possible and recommended.
94+
10095

10196
Administration and support tools
10297
--------------------------------

Documentation/dev/Developer-s-FAQ.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -360,10 +360,7 @@ of the above. Rather focus on design or potential uses and other impact.
360360
Kernel patches
361361
^^^^^^^^^^^^^^
362362

363-
If you think you're able to provide the expected quality of patches and are
364-
familiar with a bit more advanced git use, ask the maintainers. If you're a
365-
long-term developer, the maintainers can also ask you to start the pull-based
366-
workflow. The main point for the workflow is to make maintainers' life easier.
363+
Workflow is described at https://github.com/btrfs/btrfs-workflow .
367364

368365
Suggested branch names for patchsets for current development cycle:
369366

0 commit comments

Comments
 (0)