Merge #7171 from justinmk/doc

4 files changed, 44 insertions, 56 deletions

diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index 2bc31b2812..cfbe34b848 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -484,7 +484,8 @@ void nvim_set_option(String name, Object value, Error *err)
   set_option_to(NULL, SREQ_GLOBAL, name, value, err);
 }
 
-/// Writes a message to vim output buffer
+/// Writes a message to the Vim output buffer. Does not append "\n", the
+/// message is buffered (won't display) until a linefeed is written.
 ///
 /// @param str Message
 void nvim_out_write(String str)
@@ -493,7 +494,8 @@ void nvim_out_write(String str)
   write_msg(str, false);
 }
 
-/// Writes a message to vim error buffer
+/// Writes a message to the Vim error buffer. Does not append "\n", the
+/// message is buffered (won't display) until a linefeed is written.
 ///
 /// @param str Message
 void nvim_err_write(String str)
@@ -502,8 +504,8 @@ void nvim_err_write(String str)
   write_msg(str, true);
 }
 
-/// Writes a message to vim error buffer. Appends a linefeed to ensure all
-/// contents are written.
+/// Writes a message to the Vim error buffer. Appends "\n", so the buffer is
+/// flushed (and displayed).
 ///
 /// @param str Message
 /// @see nvim_err_write()
diff --git a/src/nvim/main.c b/src/nvim/main.c
index 3f828d7be9..a665ad1de2 100644
--- a/src/nvim/main.c
+++ b/src/nvim/main.c
@@ -1878,54 +1878,47 @@ static void usage(void)
   signal_stop();              // kill us with CTRL-C here, if you like
 
   mch_msg(_("Usage:\n"));
-  mch_msg(_("  nvim [arguments] [file ...]      Edit specified file(s)\n"));
-  mch_msg(_("  nvim [arguments] -               Read text from stdin\n"));
-  mch_msg(_("  nvim [arguments] -t <tag>        Edit file where tag is defined\n"));
-  mch_msg(_("  nvim [arguments] -q [errorfile]  Edit file with first error\n"));
-  mch_msg(_("\nArguments:\n"));
+  mch_msg(_("  nvim [options] [file ...]      Edit file(s)\n"));
+  mch_msg(_("  nvim [options] -               Read text from stdin\n"));
+  mch_msg(_("  nvim [options] -t <tag>        Edit file where tag is defined\n"));
+  mch_msg(_("  nvim [options] -q [errorfile]  Edit file with first error\n"));
+  mch_msg(_("\nOptions:\n"));
   mch_msg(_("  --                    Only file names after this\n"));
-#if !defined(UNIX)
-  mch_msg(_("  --literal             Don't expand wildcards\n"));
-#endif
-  mch_msg(_("  -e                    Ex mode\n"));
-  mch_msg(_("  -E                    Improved Ex mode\n"));
-  mch_msg(_("  -s                    Silent (batch) mode (only for ex mode)\n"));
+  mch_msg(_("  +                     Start at end of file\n"));
+  mch_msg(_("  --cmd <cmd>           Execute <cmd> before any config\n"));
+  mch_msg(_("  +<cmd>, -c <cmd>      Execute <cmd> after config and first file\n"));
+  mch_msg("\n");
+  mch_msg(_("  -b                    Binary mode\n"));
   mch_msg(_("  -d                    Diff mode\n"));
-  mch_msg(_("  -R                    Read-only mode\n"));
-  mch_msg(_("  -Z                    Restricted mode\n"));
+  mch_msg(_("  -e, -E                Ex mode, Improved Ex mode\n"));
+  mch_msg(_("  -es                   Silent (batch) mode\n"));
+  mch_msg(_("  -h, --help            Print this help message\n"));
+  mch_msg(_("  -i <shada>            Use this shada file\n"));
   mch_msg(_("  -m                    Modifications (writing files) not allowed\n"));
   mch_msg(_("  -M                    Modifications in text not allowed\n"));
-  mch_msg(_("  -b                    Binary mode\n"));
-  mch_msg(_("  -l                    Lisp mode\n"));
-  mch_msg(_("  -A                    Arabic mode\n"));
-  mch_msg(_("  -F                    Farsi mode\n"));
-  mch_msg(_("  -H                    Hebrew mode\n"));
-  mch_msg(_("  -V[N][file]           Be verbose [level N][log messages to file]\n"));
-  mch_msg(_("  -D                    Debugging mode\n"));
   mch_msg(_("  -n                    No swap file, use memory only\n"));
-  mch_msg(_("  -r, -L                List swap files and exit\n"));
-  mch_msg(_("  -r <file>             Recover crashed session\n"));
-  mch_msg(_("  -u <vimrc>            Use <vimrc> instead of the default\n"));
-  mch_msg(_("  -i <shada>            Use <shada> instead of the default\n"));
-  mch_msg(_("  --noplugin            Don't load plugin scripts\n"));
-  mch_msg(_("  -o[N]                 Open N windows (default: one for each file)\n"));
-  mch_msg(_("  -O[N]                 Like -o but split vertically\n"));
-  mch_msg(_("  -p[N]                 Open N tab pages (default: one for each file)\n"));
-  mch_msg(_("  +                     Start at end of file\n"));
-  mch_msg(_("  +<linenum>            Start at line <linenum>\n"));
-  mch_msg(_("  +/<pattern>           Start at first occurrence of <pattern>\n"));
-  mch_msg(_("  --cmd <command>       Execute <command> before loading any vimrc\n"));
-  mch_msg(_("  -c <command>          Execute <command> after loading the first file\n"));
+  mch_msg(_("  -o[N]                 Open N windows (default: one per file)\n"));
+  mch_msg(_("  -O[N]                 Open N vertical windows (default: one per file)\n"));
+  mch_msg(_("  -p[N]                 Open N tab pages (default: one per file)\n"));
+  mch_msg(_("  -r, -L                List swap files\n"));
+  mch_msg(_("  -r <file>             Recover edit state for this file\n"));
+  mch_msg(_("  -R                    Read-only mode\n"));
   mch_msg(_("  -S <session>          Source <session> after loading the first file\n"));
   mch_msg(_("  -s <scriptin>         Read Normal mode commands from <scriptin>\n"));
-  mch_msg(_("  -w <scriptout>        Append all typed characters to <scriptout>\n"));
-  mch_msg(_("  -W <scriptout>        Write all typed characters to <scriptout>\n"));
-  mch_msg(_("  --startuptime <file>  Write startup timing messages to <file>\n"));
-  mch_msg(_("  --api-info            Dump API metadata serialized to msgpack and exit\n"));
+  mch_msg(_("  -u <config>           Use this config file\n"));
+  mch_msg(_("  -v, --version         Print version information\n"));
+  mch_msg(_("  -V[N][file]           Verbose [level][file]\n"));
+  mch_msg(_("  -Z                    Restricted mode\n"));
+  mch_msg("\n");
+  mch_msg(_("  --api-info            Write msgpack-encoded API metadata to stdout\n"));
   mch_msg(_("  --embed               Use stdin/stdout as a msgpack-rpc channel\n"));
   mch_msg(_("  --headless            Don't start a user interface\n"));
-  mch_msg(_("  -v, --version         Print version information and exit\n"));
-  mch_msg(_("  -h, --help            Print this help message and exit\n"));
+#if !defined(UNIX)
+  mch_msg(_("  --literal             Don't expand wildcards\n"));
+#endif
+  mch_msg(_("  --noplugin            Don't load plugins\n"));
+  mch_msg(_("  --startuptime <file>  Write startup timing messages to <file>\n"));
+  mch_msg(_("\nSee \":help startup-options\" for all options.\n"));
 }
 
 
diff --git a/src/nvim/testdir/test_startup.vim b/src/nvim/testdir/test_startup.vim
index 64f7f31294..5a38178bd5 100644
--- a/src/nvim/testdir/test_startup.vim
+++ b/src/nvim/testdir/test_startup.vim
@@ -76,11 +76,11 @@ func Test_help_arg()
     let found = []
     for line in lines
       if line =~ '-R.*Read-only mode'
-	call add(found, 'Readonly mode')
+        call add(found, 'Readonly mode')
       endif
       " Watch out for a second --version line in the Gnome version.
-      if line =~ '--version.*Print version information and exit'
-	call add(found, "--version")
+      if line =~ '--version.*Print version information'
+        call add(found, "--version")
       endif
     endfor
     call assert_equal(['Readonly mode', '--version'], found)
diff --git a/src/nvim/version.c b/src/nvim/version.c
index f5b45caefc..2a3fdbd70d 100644
--- a/src/nvim/version.c
+++ b/src/nvim/version.c
@@ -1089,13 +1089,7 @@ static void list_features(void)
           msg_putchar('\n');
         }
       } else {
-        while (msg_col % width) {
-          int old_msg_col = msg_col;
-          msg_putchar(' ');
-          if (old_msg_col == msg_col) {
-            break;  // XXX: Avoid infinite loop.
-          }
-        }
+        msg_putchar(' ');
       }
     } else {
       if (msg_col > 0) {
@@ -1103,7 +1097,7 @@ static void list_features(void)
       }
     }
   }
-  MSG_PUTS("For differences from Vim, see :help vim-differences\n\n");
+  MSG_PUTS("See \":help feature-compile\"\n\n");
 }
 
 void list_version(void)
@@ -1144,7 +1138,7 @@ void list_version(void)
   }
 #endif  // ifdef HAVE_PATHDEF
 
-  version_msg(_("\n\nOptional features included (+) or not (-): "));
+  version_msg(_("\n\nFeatures: "));
 
   list_features();
 
@@ -1216,7 +1210,6 @@ void intro_message(int colon)
   static char *(lines[]) = {
     N_(NVIM_VERSION_LONG),
     "",
-    N_("by al."),
     N_("Nvim is open source and freely distributable"),
     N_("https://neovim.io/community"),
     "",