aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2025-07-11 21:03:37 +0200
committerJonas Bernoulli <jonas@bernoul.li>2025-07-11 21:03:37 +0200
commitd8b4690900a00bc32e9f4dd0fb71b96614a96b51 (patch)
treef83e4d188a39d0f9ea0be79b1495a6109a7245e8 /docs
parentc9d9ce1b9ad1352bcaf57514c35bbfc946ebff62 (diff)
Document return value of functions running process synchronously
Diffstat (limited to 'docs')
-rw-r--r--docs/magit.org3
-rw-r--r--docs/magit.texi3
2 files changed, 6 insertions, 0 deletions
diff --git a/docs/magit.org b/docs/magit.org
index 5d9603b..4acd600 100644
--- a/docs/magit.org
+++ b/docs/magit.org
@@ -8638,6 +8638,9 @@ wait for git to complete before letting the user do something else.
For example after staging a change it is useful to wait until after
the refresh because that also automatically moves to the next change.
+The synchronous functions return the exit code, while the asynchronous
+functions return the process object.
+
- Function: magit-call-git &rest args ::
Calls git synchronously with ARGS.
diff --git a/docs/magit.texi b/docs/magit.texi
index 7d40e0d..9fc283b 100644
--- a/docs/magit.texi
+++ b/docs/magit.texi
@@ -10371,6 +10371,9 @@ wait for git to complete before letting the user do something else.
For example after staging a change it is useful to wait until after
the refresh because that also automatically moves to the next change.
+The synchronous functions return the exit code, while the asynchronous
+functions return the process object.
+
@defun magit-call-git &rest args
Calls git synchronously with ARGS@.
@end defun