Bug in documentation

Bug in documentation

[Felix_Schulte-dDVk9ABzqyjQT0dZR+AlfA]

Hi!

The documentation for inotify is a bit misleading
(http://man7.org/linux/man-pages/man7/inotify.7.html)

It says when describing the "mask" field:
IN_MOVED_FROM     File moved out of watched directory (*).

The description is not correct, since this event is also fired (on
read()) when a file is moved *within* the same directory (to a new name)
and is explicitly *not* *moved out* of the directory.

It's not a big deal, of course, I just was confused about it recently.

Ciao
Felix
Firmensitz: Muenchen Amtsgericht: AG Muenchen Handelsregister: HRB 144340 Geschaeftsfuehrer: Timothy James Daly, Jonathan Park, Martin Stecher Bankverbindung: ABN-Amro Bank N.V. Konto 671 211 9006 UST-ID: DE168122444
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: Bug in documentation

[Michael Kerrisk]

On 07/19/13 13:37, Felix_Schulte-dDVk9ABzqyjQT0dZR+AlfA@public.gmane.org wrote:
> Hi!
> 
> The documentation for inotify is a bit misleading
> (http://man7.org/linux/man-pages/man7/inotify.7.html)
> 
> It says when describing the "mask" field:
> IN_MOVED_FROM     File moved out of watched directory (*).
> 
> The description is not correct, since this event is also fired (on
> read()) when a file is moved *within* the same directory (to a new name)
> and is explicitly *not* *moved out* of the directory.
> 
> It's not a big deal, of course, I just was confused about it recently.

Hello Felix,

I agree, it could be clearer. I revised the text to read:

           IN_MOVED_FROM     Generated  for  the  directory containing the
                             old filename when a file is renamed (*).
           IN_MOVED_TO       Generated for the  directory  containing  the
                             new filename when a file is renamed (*).

Okay?

Cheers,

Michael
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: Bug in documentation

[Felix_Schulte-dDVk9ABzqyjQT0dZR+AlfA]

Hi Michael,

your suggestion sounds good to me :)

Ciao
Felix

On 21.07.2013 00:28, Michael Kerrisk wrote:
> On 07/19/13 13:37, Felix_Schulte-dDVk9ABzqyjQT0dZR+AlfA@public.gmane.org wrote:
>> Hi!
>>
>> The documentation for inotify is a bit misleading
>> (http://man7.org/linux/man-pages/man7/inotify.7.html)
>>
>> It says when describing the "mask" field:
>> IN_MOVED_FROM     File moved out of watched directory (*).
>>
>> The description is not correct, since this event is also fired (on
>> read()) when a file is moved *within* the same directory (to a new name)
>> and is explicitly *not* *moved out* of the directory.
>>
>> It's not a big deal, of course, I just was confused about it recently.
>
> Hello Felix,
>
> I agree, it could be clearer. I revised the text to read:
>
>            IN_MOVED_FROM     Generated  for  the  directory containing the
>                              old filename when a file is renamed (*).
>            IN_MOVED_TO       Generated for the  directory  containing  the
>                              new filename when a file is renamed (*).
>
> Okay?
>
> Cheers,
>
> Michael
>
Firmensitz: Muenchen Amtsgericht: AG Muenchen Handelsregister: HRB 144340 Geschaeftsfuehrer: Timothy James Daly, Jonathan Park, Martin Stecher Bankverbindung: ABN-Amro Bank N.V. Konto 671 211 9006 UST-ID: DE168122444
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html