doc: git-mr-create add info about default tags
authorFrantisek Hrbata <frantisek@hrbata.com>
Sun, 20 Dec 2020 14:56:22 +0000 (15:56 +0100)
committerFrantisek Hrbata <frantisek@hrbata.com>
Sun, 20 Dec 2020 14:56:22 +0000 (15:56 +0100)
Signed-off-by: Frantisek Hrbata <frantisek@hrbata.com>
Documentation/git-mr-create.txt

index cccde1291ab706036977fb1e854cf90e45c18c03..57bac1362408b0a75afef1f2074072476c2595f3 100644 (file)
@@ -18,8 +18,18 @@ DESCRIPTION
 Creates a new MR (merge request) from 'REV', which is a revision in
 whatever form is accepted by git. If 'REV' is not specified, 'HEAD'
 is used as the default value. New MR is identified by the full 'SHA-1' of 'REV'
-and a new reference is created under the 'mrs' refs namespace
-'refs/mrs/<mr-sha-1>/<user>/head'.
+and three new references are created under the 'mrs' refs namespace.
+
+. 'refs/mrs/<mr-sha-1>/<user>/head'
+* This is just a pointer to the MR tip commit.
+
+. 'refs/mrs/<mr-sha-1>/<user>/mr'
+* Basic MR tags which cannot be changed. See *RESERVED TAGS* in
+link:git-mr-tag.html[git-mr-tag(1)].
+
+. 'refs/mrs/<mr-sha-1>/<user>/tags'
+* Initial user tags with MR subject and description. These can be
+changed by the MR author.
 
 Each MR has to have a base specified with the *-b* argument. It's a 'REV' the
 MR is based on.
@@ -46,6 +56,7 @@ OPTIONS
     Use 'MSG' as MR description. Multiple 'MSG's are concatenated as separate
     paragraphs.
 
+
 EXAMPLES
 --------
 Create a new MR based on 'master' branch.