Skip to content

Commit 80f04f0

Browse files
committed
Remove duplicate help tag (issue #20)
See issue #20 on GitHub: #20
1 parent 1e1a116 commit 80f04f0

3 files changed

Lines changed: 16 additions & 9 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ Because Vim's [v:shell_error] [] variable is read only (which means it cannot be
5454

5555
The `:MakeWithShell` command uses Vim's [quickfix window] []. To make the shell plug-in use the [location-list] [] instead you can use the command `:LMakeWithShell` instead.
5656

57-
### The `xolox#misc#os#exec()` function
57+
### The `xolox#shell#execute_with_dll()` function
58+
59+
The function `xolox#shell#execute_with_dll()` is used by `xolox#misc#os#exec()` and shouldn't be called directly; instead please call `xolox#misc#os#exec()` (this is what my plug-ins do). For this reason the remainder of the following text discusses the `xolox#misc#os#exec()` function.
5860

5961
This function enables other Vim plug-ins to execute external commands in the background (i.e. asynchronously) *without opening a command prompt window on Windows*. For example try to execute the following command on Windows ([vimrun.exe] [vimrun] is only included with Vim for Windows because it isn't needed on other platforms):
6062

@@ -64,7 +66,7 @@ Immediately after executing this command Vim will respond to input again because
6466

6567
The function returns a dictionary of return values. In asynchronous mode the dictionary is empty. In synchronous mode it contains the following key/value pairs:
6668

67-
:echo xolox#misc#os#exec({'command': 'echo "this is stdout" && echo "this is stderr" >&2 && exit 42'})
69+
:echo xolox#misc#os#exec({'command': 'echo "this is stdout" && echo "this is stderr" >&2 && exit 42', 'check': 0})
6870
{'exit_code': 42, 'stdout': ['this is stdout'], 'stderr': ['this is stderr']}
6971

7072
If you want to verify that this function works as described, execute the command mentioning `vimrun` above, open the Windows task manager by pressing `Control-Shift-Escape` and check that the process `vimrun.exe` is listed in the processes tab. If you don't see the problem this is solving, try executing [vimrun.exe] [vimrun] using Vim's built-in [system()] [system] function instead:

autoload/xolox/shell.vim

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
" Vim auto-load script
22
" Author: Peter Odding <peter@peterodding.com>
3-
" Last Change: August 19, 2013
3+
" Last Change: September 2, 2013
44
" URL: http://peterodding.com/code/vim/shell/
55

6-
let g:xolox#shell#version = '0.13.1'
6+
let g:xolox#shell#version = '0.13.2'
77

88
if !exists('s:fullscreen_enabled')
99
let s:enoimpl = "%s() hasn't been implemented on your platform! %s"

doc/shell.txt

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Contents ~
1010
2. The |:Fullscreen| command
1111
3. The |:Open| command
1212
4. The |:MakeWithShell| command
13-
5. The |xolox#misc#os#exec()| function
13+
5. The |xolox#shell#execute_with_dll()| function
1414
6. The |xolox#shell#fullscreen()| function
1515
7. The |xolox#shell#is_fullscreen()| function
1616
8. The |g:shell_fullscreen_items| option
@@ -43,7 +43,7 @@ This plug-in aims to improve the integration between Vim and its environment
4343
names, URLs and e-mail addresses in your favorite programs (file manager,
4444
web browser, e-mail client, etc).
4545

46-
- The |xolox#misc#os#exec()| function enables other Vim plug-ins (like my
46+
- The 'xolox#misc#os#exec()' function enables other Vim plug-ins (like my
4747
easytags.vim [2] plug-in) to execute external commands in the background
4848
(i.e. asynchronously) _without opening a command prompt window on Windows_.
4949

@@ -136,7 +136,12 @@ plug-in use the |location-list| instead you can use the command
136136
':LMakeWithShell' instead.
137137

138138
-------------------------------------------------------------------------------
139-
The *xolox#misc#os#exec()* function
139+
The *xolox#shell#execute_with_dll()* function
140+
141+
The function |xolox#shell#execute_with_dll()| is used by 'xolox#misc#os#exec()'
142+
and shouldn't be called directly; instead please call 'xolox#misc#os#exec()'
143+
(this is what my plug-ins do). For this reason the remainder of the following
144+
text discusses the 'xolox#misc#os#exec()' function.
140145

141146
This function enables other Vim plug-ins to execute external commands in the
142147
background (i.e. asynchronously) _without opening a command prompt window on
@@ -147,7 +152,7 @@ it isn't needed on other platforms):
147152
:call xolox#misc#os#exec({'command': 'vimrun', 'async': 1})
148153
<
149154
Immediately after executing this command Vim will respond to input again
150-
because |xolox#misc#os#exec()| doesn't wait for the external command to finish
155+
because 'xolox#misc#os#exec()' doesn't wait for the external command to finish
151156
when the 'async' argument is true (1). In addition no command prompt window
152157
will be shown which means vimrun.exe (see |win32-vimrun|) is running completely
153158
invisible in the background.
@@ -156,7 +161,7 @@ The function returns a dictionary of return values. In asynchronous mode the
156161
dictionary is empty. In synchronous mode it contains the following key/value
157162
pairs:
158163
>
159-
:echo xolox#misc#os#exec({'command': 'echo "this is stdout" && echo "this is stderr" >&2 && exit 42'})
164+
:echo xolox#misc#os#exec({'command': 'echo "this is stdout" && echo "this is stderr" >&2 && exit 42', 'check': 0})
160165
{'exit_code': 42, 'stdout': ['this is stdout'], 'stderr': ['this is stderr']}
161166
<
162167
If you want to verify that this function works as described, execute the

0 commit comments

Comments
 (0)