bug#24693: Small doc improvement of start-process

bug#24693: Small doc improvement of start-process

[Hong Xu]

[-- Attachment #1.1.1: Type: text/plain, Size: 115 bytes --]

PROGARM-ARGS are not mentioned in the docstring. The attached patch is a
draft of the small improvement. Thanks!

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.1.2: doc-improvement.patch --]
[-- Type: text/x-patch; name="doc-improvement.patch", Size: 608 bytes --]

diff --git a/lisp/subr.el b/lisp/subr.el
index 8a1792ad8b78..c3524ef1fccb 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -2001,6 +2001,9 @@ PROGRAM is the program file name.  It is searched for in `exec-path'
 \(which see).  If nil, just associate a pty with the buffer.  Remaining
 arguments are strings to give program as arguments.
 
+PROGRAM-ARGS are strings that specify command line arguments for the
+subprocess.
+
 If you want to separate standard output from standard error, use
 `make-process' or invoke the command through a shell and redirect
 one of them using the shell syntax."

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

bug#24693: Small doc improvement of start-process

[Andreas Schwab]

On Okt 14 2016, Hong Xu <hong@topbug.net> wrote:

> PROGARM-ARGS are not mentioned in the docstring. The attached patch is a
> draft of the small improvement. Thanks!
>
> diff --git a/lisp/subr.el b/lisp/subr.el
> index 8a1792ad8b78..c3524ef1fccb 100644
> --- a/lisp/subr.el
> +++ b/lisp/subr.el
> @@ -2001,6 +2001,9 @@ PROGRAM is the program file name.  It is searched for in `exec-path'
>  \(which see).  If nil, just associate a pty with the buffer.  Remaining
>  arguments are strings to give program as arguments.
>  
> +PROGRAM-ARGS are strings that specify command line arguments for the
> +subprocess.
> +

That's what it says in the preceding sentence.

Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

bug#24693: Small doc improvement of start-process

[Hong Xu]

[-- Attachment #1.1: Type: text/plain, Size: 887 bytes --]

On 10/14/2016 11:25 AM, Andreas Schwab wrote:
> On Okt 14 2016, Hong Xu <hong@topbug.net> wrote:
> 
>> PROGARM-ARGS are not mentioned in the docstring. The attached patch is a
>> draft of the small improvement. Thanks!
>>
>> diff --git a/lisp/subr.el b/lisp/subr.el
>> index 8a1792ad8b78..c3524ef1fccb 100644
>> --- a/lisp/subr.el
>> +++ b/lisp/subr.el
>> @@ -2001,6 +2001,9 @@ PROGRAM is the program file name.  It is searched for in `exec-path'
>>  \(which see).  If nil, just associate a pty with the buffer.  Remaining
>>  arguments are strings to give program as arguments.
>>  
>> +PROGRAM-ARGS are strings that specify command line arguments for the
>> +subprocess.
>> +
> 
> That's what it says in the preceding sentence.
> 

I see. Maybe mention PROGRAM-ARGS explicitly like: Remaining
arguments PROGRAM-ARGS are strings to give program as arguments.



[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

bug#24693: Small doc improvement of start-process

[Hong Xu]

[-- Attachment #1.1: Type: text/plain, Size: 286 bytes --]

On 10/14/2016 11:39 AM, Hong Xu wrote:
> 
> I see. Maybe mention PROGRAM-ARGS explicitly like: Remaining
> arguments PROGRAM-ARGS are strings to give program as arguments.
> 
> 

Can we push the small fix? This is a tiny fix but it certainly improves
the quality of the doc.


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

bug#24693: Small doc improvement of start-process

[Eli Zaretskii]

> From: Hong Xu <hong@topbug.net>
> Date: Mon, 17 Oct 2016 17:06:01 -0700
> 
> On 10/14/2016 11:39 AM, Hong Xu wrote:
> > 
> > I see. Maybe mention PROGRAM-ARGS explicitly like: Remaining
> > arguments PROGRAM-ARGS are strings to give program as arguments.
> > 
> 
> Can we push the small fix? This is a tiny fix but it certainly improves
> the quality of the doc.

Done.

Thanks.