Bug 461208 - man page is not clear
man page is not clear
Product: Fedora
Classification: Fedora
Component: mlocate (Show other bugs)
All Linux
medium Severity medium
: ---
: ---
Assigned To: Miloslav Trmač
Fedora Extras Quality Assurance
Depends On:
  Show dependency treegraph
Reported: 2008-09-04 17:45 EDT by Need Real Name
Modified: 2008-09-08 16:59 EDT (History)
1 user (show)

See Also:
Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
Last Closed: 2008-09-08 16:59:58 EDT
Type: ---
Regression: ---
Mount Type: ---
Documentation: ---
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---

Attachments (Terms of Use)

  None (edit)
Description Need Real Name 2008-09-04 17:45:58 EDT
I've tried reading this section of the man page many times now, but I can't make sense of it:

$ man updatedb.conf
       Unlike  the  traditional  behavior  of  PRUNEFS  and  PRUNEPATHS, which
       excludes the matched directory (or the root of a matched  file  system)
       from the created database, the matched directory is entered in the cre-
       ated database.  This allows e.g.  locate /tmp to find the standard tem-
       porary  directories  even  though  their contents are excluded from the
Comment 1 Miloslav Trmač 2008-09-04 18:06:47 EDT
Thanks for your report.

Can you describe more precisely what's unclear, please?  Or perhaps suggest an alternate wording?
Comment 2 Need Real Name 2008-09-04 18:14:01 EDT
I would happily suggest alternate wording, but I don't know what the paragraph is trying to say.

If there were shorter, clearer sentences, rewritten without use of brackets, without use of "e.g." then it would make more sense.
Comment 3 Miloslav Trmač 2008-09-08 15:50:51 EDT
Is this a bit better?

When a directory is matched by PRUNEFS, PRUNENAMES or PRUNEPATHS, updatedb(8) does not scan the contents of the directory.  The path of the directory itself is, however, entered in the created database.  For example, if /tmp is in PRUNEPATHS, locate(1) will not show any files stored in /tmp, but it can show the "/tmp" directory.  This behavior differs from traditional locate implementations.
Comment 4 Need Real Name 2008-09-08 16:00:27 EDT
Ah now I get it! Makes perfect sense now, excellent :)
Comment 5 Miloslav Trmač 2008-09-08 16:59:58 EDT
Thanks, fixed in the repository.

The updated man page will be available in the next mlocate release.

Note You need to log in before you can comment on or make changes to this bug.