diff options
| author | Sean Whitton | 2025-07-11 09:29:12 +0100 |
|---|---|---|
| committer | Sean Whitton | 2025-07-11 09:29:12 +0100 |
| commit | 0814a93a040fffbf9d0be75b1ebdf432c0ce5f3c (patch) | |
| tree | 2d7375b02974b72a16b3fb2efd051372edefc36e | |
| parent | 191109e25e51b986e1029b5a5010ced07507a73a (diff) | |
| download | emacs-0814a93a040fffbf9d0be75b1ebdf432c0ce5f3c.tar.gz emacs-0814a93a040fffbf9d0be75b1ebdf432c0ce5f3c.zip | |
; Improve manual docs for incoming and outgoing diff commands
| -rw-r--r-- | doc/emacs/maintaining.texi | 31 |
1 files changed, 20 insertions, 11 deletions
diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi index 895f19453e4..84191490e50 100644 --- a/doc/emacs/maintaining.texi +++ b/doc/emacs/maintaining.texi | |||
| @@ -1085,9 +1085,7 @@ non-@code{nil}, @kbd{C-x v O} becomes a prefix key, and | |||
| 1085 | 1085 | ||
| 1086 | @item M-x vc-root-diff-outgoing | 1086 | @item M-x vc-root-diff-outgoing |
| 1087 | Display a diff of the changes that will be sent by the next push | 1087 | Display a diff of the changes that will be sent by the next push |
| 1088 | operation. This command is useful as a way to preview your push and | 1088 | operation. |
| 1089 | ensure that all and only the changes you intended to include were | ||
| 1090 | committed and will be pushed. | ||
| 1091 | 1089 | ||
| 1092 | If you customize @code{vc-use-incoming-outgoing-prefixes} to | 1090 | If you customize @code{vc-use-incoming-outgoing-prefixes} to |
| 1093 | non-@code{nil}, this command is bound to @kbd{C-x v O D}. | 1091 | non-@code{nil}, this command is bound to @kbd{C-x v O D}. |
| @@ -1163,16 +1161,27 @@ prompts for the branch whose history to display. | |||
| 1163 | @findex vc-log-outgoing | 1161 | @findex vc-log-outgoing |
| 1164 | On a decentralized version control system, the @kbd{C-x v I} | 1162 | On a decentralized version control system, the @kbd{C-x v I} |
| 1165 | (@code{vc-log-incoming}) command displays a log buffer showing the | 1163 | (@code{vc-log-incoming}) command displays a log buffer showing the |
| 1166 | changes that will be applied, the next time you run the version | 1164 | changes that will be applied the next time you run the version control |
| 1167 | control system's pull command to get new revisions from another | 1165 | system's pull command to get new revisions from another remote location |
| 1168 | remote location (@pxref{Pulling / Pushing}). This other remote location is the default | 1166 | (@pxref{Pulling / Pushing}). This other remote location is the default |
| 1169 | one from which changes are pulled, as defined by the version control | 1167 | one from which changes are pulled, as defined by the version control |
| 1170 | system; with a prefix argument, @code{vc-log-incoming} prompts for a | 1168 | system; with a prefix argument, @code{vc-log-incoming} prompts for a |
| 1171 | specific remote location. Similarly, @kbd{C-x v O} | 1169 | particular remote location. Similarly, @kbd{C-x v O} |
| 1172 | (@code{vc-log-outgoing}) shows the changes that will be sent to | 1170 | (@code{vc-log-outgoing}) shows the changes that will be sent to another |
| 1173 | another remote location, the next time you run the push command; with a | 1171 | remote location, the next time you run the push command; with a prefix |
| 1174 | prefix argument, it prompts for a specific destination that | 1172 | argument, it prompts for a particular destination that in case of some |
| 1175 | in case of some version control system can be a branch name. | 1173 | version control system can be a branch name. |
| 1174 | |||
| 1175 | @findex vc-root-diff-incoming | ||
| 1176 | @findex vc-root-diff-outgoing | ||
| 1177 | The closely related commands @code{vc-root-diff-incoming} and | ||
| 1178 | @code{vc-root-diff-outgoing} are the diff analogues of | ||
| 1179 | @code{vc-log-incoming} and @code{vc-log-outgoing}. These display a diff | ||
| 1180 | buffer reporting the changes that would be pulled or pushed. You can | ||
| 1181 | use a prefix argument here too to specify a particular remote location. | ||
| 1182 | @code{vc-root-diff-outgoing} is useful as a way to preview your push and | ||
| 1183 | quickly check that all and only the changes you intended to include were | ||
| 1184 | committed and will be pushed. | ||
| 1176 | 1185 | ||
| 1177 | @cindex VC log buffer, commands in | 1186 | @cindex VC log buffer, commands in |
| 1178 | @cindex vc-log buffer | 1187 | @cindex vc-log buffer |