Re: [PATCH 3/4] docs: improve setarch(8) manual page

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 4 December 2017 at 12:04, Karel Zak <kzak@xxxxxxxxxx> wrote:
> On Sun, Dec 03, 2017 at 12:51:16PM +0000, Sami Kerola wrote:
>>  \fB\-3\fR, \fB\-\-3gb\fR
>> -Specifies that processes should use a maximum of 3GB of address space on systems where it is supported (ADDR_LIMIT_3GB).
>> +Specifies
>> +.I program
>> +should use a maximum of 3GB of address space.  Supported on x86 (as of
>> +2017-12-02).  Turns on ADDR_LIMIT_3GB.
>
> What is the magic day 2017-12-02 ?
>
> Frankly, I don't like dates in docs. It's better to use versions
> "since util-linux v2.31" or "since Linux v4.32", etc.

Fair enough. I will figure out how to make this better.

>>  \fB\-\-4gb\fR
>> -Ignored (for backward compatibility only).
>> +Ignored for backward compatibility only.
>
> Dmitry is right, the old version is better.

How about text:

This option is no-op compatibility with an old Debian setarch
implementation. Please do not use.

>> +This makes
>> +.BR select (2),
>> +.BR pselect (2),
>> +and
>> +.BR ppoll (2)
>> +system calls preserve the timeout value instead of storing the unslept time
>> +when interrupted by a signal handler.  Use when
>> +.I program
>> +depends on this behavior, and the source code is not available to be fixed.
>
> See Dmitry's note ;-)

How about this:

-- snip
This makes
.BR select (2),
.BR pselect (2),
and
.BR ppoll (2)
system calls preserve the timeout value instead of storing the unslept time
when interrupted by a signal handler. Use when
.I program
depends on this behavior. For more details see the timeout description from
.BR select (2)
manual page. Turns on STICKY_TIMEOUTS.
-- snip

My remote git has the latest.

https://github.com/kerolasa/lelux-utiliteetit/blob/2017wk48/sys-utils/setarch.8

And that branch also has FIXME item near FDPIC_FUNCPTRS description.
Proposal(s) welcome how to make that text understandable.

-- 
Sami Kerola
http://www.iki.fi/kerolasa/
--
To unsubscribe from this list: send the line "unsubscribe util-linux" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Netdev]     [Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux