From 2a8ed18196145b15f2e2816f66f9e76ea77e5f7f Mon Sep 17 00:00:00 2001 From: Pawel Lipski Date: Fri, 19 Apr 2024 23:20:30 +0200 Subject: [PATCH] Fix docs for `restack-{pr,mr}` --- docs/man/git-machete.1 | 10 +++++----- docs/source/cli/github.rst | 2 +- docs/source/cli/gitlab.rst | 2 +- git_machete/generated_docs.py | 8 ++++---- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/man/git-machete.1 b/docs/man/git-machete.1 index 182cfdb7e..95e5542c9 100644 --- a/docs/man/git-machete.1 +++ b/docs/man/git-machete.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "GIT-MACHETE" "1" "Apr 15, 2024" "" "git-machete" +.TH "GIT-MACHETE" "1" "Apr 19, 2024" "" "git-machete" .SH NAME git-machete \- git-machete 3.25.1 .sp @@ -1023,9 +1023,9 @@ Perform the following sequence of actions: .IP 1. 3 If the PR for the current branch is ready for review, it gets converted to a draft. .IP 2. 3 -The branch is (force\-)pushed into remote. -.IP 3. 3 The PR is retargeted to its upstream (parent) branch, as in \fBretarget\-pr\fP\&. +.IP 3. 3 +The branch is (force\-)pushed into remote. .IP 4. 3 If the PR has been converted to draft in step 1, it\(aqs reverted to ready for review state. .UNINDENT @@ -1251,9 +1251,9 @@ Perform the following sequence of actions: .IP 1. 3 If the MR for the current branch is ready for review, it gets converted to a draft. .IP 2. 3 -The branch is (force\-)pushed into remote. -.IP 3. 3 The MR is retargeted to its upstream (parent) branch, as in \fBretarget\-mr\fP\&. +.IP 3. 3 +The branch is (force\-)pushed into remote. .IP 4. 3 If the MR has been converted to draft in step 1, it\(aqs reverted to ready for review state. .UNINDENT diff --git a/docs/source/cli/github.rst b/docs/source/cli/github.rst index 2b6a906ca..127634689 100644 --- a/docs/source/cli/github.rst +++ b/docs/source/cli/github.rst @@ -102,8 +102,8 @@ Creates, checks out and manages GitHub PRs while keeping them reflected in branc Perform the following sequence of actions: #. If the PR for the current branch is ready for review, it gets converted to a draft. - #. The branch is (force-)pushed into remote. #. The PR is retargeted to its upstream (parent) branch, as in ``retarget-pr``. + #. The branch is (force-)pushed into remote. #. If the PR has been converted to draft in step 1, it's reverted to ready for review state. The drafting/undrafting is useful in case the GitHub repository has set up `CODEOWNERS `_. diff --git a/docs/source/cli/gitlab.rst b/docs/source/cli/gitlab.rst index 06ab95d70..c6ef38c7d 100644 --- a/docs/source/cli/gitlab.rst +++ b/docs/source/cli/gitlab.rst @@ -103,8 +103,8 @@ Creates, checks out and manages GitLab MRs while keeping them reflected in branc Perform the following sequence of actions: #. If the MR for the current branch is ready for review, it gets converted to a draft. - #. The branch is (force-)pushed into remote. #. The MR is retargeted to its upstream (parent) branch, as in ``retarget-mr``. + #. The branch is (force-)pushed into remote. #. If the MR has been converted to draft in step 1, it's reverted to ready for review state. The drafting/undrafting is useful in case the GitLab project has set up `code owners `_. diff --git a/git_machete/generated_docs.py b/git_machete/generated_docs.py index 153419eb9..77f1f0635 100644 --- a/git_machete/generated_docs.py +++ b/git_machete/generated_docs.py @@ -616,10 +616,10 @@ * If the PR for the current branch is ready for review, it gets converted to a draft. - * The branch is (force-)pushed into remote. - * The PR is retargeted to its upstream (parent) branch, as in `retarget-pr`. + * The branch is (force-)pushed into remote. + * If the PR has been converted to draft in step 1, it's reverted to ready for review state. The drafting/undrafting is useful in case the GitHub repository has set up CODEOWNERS. @@ -797,10 +797,10 @@ * If the MR for the current branch is ready for review, it gets converted to a draft. - * The branch is (force-)pushed into remote. - * The MR is retargeted to its upstream (parent) branch, as in `retarget-mr`. + * The branch is (force-)pushed into remote. + * If the MR has been converted to draft in step 1, it's reverted to ready for review state. The drafting/undrafting is useful in case the GitLab project has set up code owners.