Przeglądaj źródła

Improve documentation for MobileOrg

Carsten Dominik 15 lat temu
rodzic
commit
d5f8d47192
2 zmienionych plików z 14 dodań i 12 usunięć
  1. 5 3
      doc/org.texi
  2. 9 9
      lisp/org-mobile.el

+ 5 - 3
doc/org.texi

@@ -11725,9 +11725,11 @@ and operates on the pointers to flagged entries.  Here is how it works:
 
 @enumerate
 @item
-Org moves all entries found in @file{mobileorg.org} and appends them to
-the file pointed to by the variable @code{org-mobile-inbox-for-pull}.  Each
-captured entry will be a top-level entry in the inbox file.
+Org moves all entries found in
+@file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
+operation.} and appends them to the file pointed to by the variable
+@code{org-mobile-inbox-for-pull}.  Each captured entry will be a top-level
+entry in the inbox file.
 @item
 After moving the entries, Org will attempt to act on the flags.  Some flags
 specify simple operations that will be executed directly and without user

+ 9 - 9
lisp/org-mobile.el

@@ -94,23 +94,23 @@ they may accumulate.")
 (defvar org-mobile-post-push-hook nil
   "Hook run after running `org-mobile-push'.
 If Emacs does not have direct write access to the WebDAV directory used
-by the mobile device, this hook could be used to copy all files from the
-local `org-mobile-directory' to the WebDAV directory, for example using
-`rsync' or `scp'.")
+by the mobile device, this hook should be used to copy all files from the
+local staging directory `org-mobile-directory' to the WebDAV directory,
+for example using `rsync' or `scp'.")
 
 (defvar org-mobile-pre-pull-hook nil
   "Hook run before executing `org-mobile-pull'.
 If Emacs does not have direct write access to the WebDAV directory used
-by the mobile device, this hook could be used to copy all files from the
-WebDAV location to the local staging directory `org-mobile-directory'.")
+by the mobile device, this hook should be used to copy the capture file
+`mobileorg.org' from the WebDAV location to the local staging
+directory `org-mobile-directory'.")
 
 (defvar org-mobile-post-pull-hook nil
   "Hook run after running `org-mobile-pull'.
 If Emacs does not have direct write access to the WebDAV directory used
-by the mobile device, this hook could be used to copy all files from the
-local `org-mobile-directory' to the WebDAV directory, for example using
-`rsync' or `scp'.  The only file that will be changed after a pull is
-`org-mobile-capture-file'.")
+by the mobile device, this hook should be used to copy the emptied
+capture file `mobileorg.org' back to the WebDAV directory, for example
+using `rsync' or `scp'.")
 
 (defvar org-mobile-last-flagged-files nil
   "List of files containing entreis flagged in the latest pull.")