indexerconfig: Describe some functions
ClosedPublic

Authored by michaelh on Feb 19 2018, 4:07 PM.

Diff Detail

Repository
R293 Baloo
Branch
publicdescriptions (branched from master)
Lint
No Linters Available
Unit
No Unit Test Coverage
michaelh created this revision.Feb 19 2018, 4:07 PM
Restricted Application added a project: Frameworks. · View Herald TranscriptFeb 19 2018, 4:07 PM
Restricted Application added a subscriber: Frameworks. · View Herald Transcript
michaelh requested review of this revision.Feb 19 2018, 4:07 PM
adridg added a subscriber: adridg.Feb 21 2018, 8:57 AM
adridg added inline comments.
src/lib/indexerconfig.h
45 ↗(On Diff #27552)

This makes it unclear if the entire path is used, (e.g. \p path) or whether some special part of the path (the dir) is used for matching. It *might* be nice to have documentation on how exactly (e.g. most-specific wins) the matching works, unless that is documented elsewhere.

47 ↗(On Diff #27552)

Is \p true really the right markup here? That's for parameters. You probably want \c true -- even though that will produce exactly the same output, the meaning is different.

53 ↗(On Diff #27552)

What does "cached and cleaned up" mean here? (Same applies below)

59 ↗(On Diff #27552)

What does "perfectly possible" mean here? This might need one or more examples, or a link to how in- and ex-clusion works.

michaelh updated this revision to Diff 27662.Feb 21 2018, 9:57 AM
  • fileindexerconfig: Make descriptions consistent
  • indexerconfig: Make descriptions consistent
michaelh added inline comments.Feb 21 2018, 10:17 AM
src/lib/indexerconfig.h
53 ↗(On Diff #27552)

Here, nothing :-)

michaelh updated this revision to Diff 27673.Feb 21 2018, 11:30 AM
  • indexerconfig: Rephrase description
michaelh marked 3 inline comments as done.Feb 21 2018, 11:35 AM
michaelh added inline comments.
src/lib/indexerconfig.h
45 ↗(On Diff #27552)

Ouch... This one hurts, but it's to the best of my abilities in English.

lbeltrame accepted this revision.Feb 22 2018, 9:46 AM
lbeltrame added a subscriber: lbeltrame.

Looks OK to me with some changes (for readability).

src/file/fileindexerconfig.h
50 ↗(On Diff #27673)

I'd put "index and analyze". Seems nitpicky, but reflects what Baloo does (index first, extraction later).

57 ↗(On Diff #27673)

"Descendant folders of an excluded folder can be added and they will be indexed."

This revision is now accepted and ready to land.Feb 22 2018, 9:46 AM
michaelh updated this revision to Diff 27762.Feb 22 2018, 10:07 AM
michaelh marked an inline comment as done.
  • Refine descriptions more
  • Apply coding style to includes
michaelh marked an inline comment as done.Feb 22 2018, 10:07 AM
michaelh added inline comments.
src/file/fileindexerconfig.h
50 ↗(On Diff #27673)

To be really nitpicky it is index > analyze > index. :-)
And...
Wtr to method descriptions/manuals one cannot be nitpicky enough!

57 ↗(On Diff #27673)

much better, thanks

michaelh marked an inline comment as done.Feb 22 2018, 10:14 AM
lbeltrame added inline comments.Feb 22 2018, 10:32 AM
src/file/fileindexerconfig.h
25 ↗(On Diff #27762)

I just noticed this. Can you do the #include changes as part of a separate commit?

michaelh updated this revision to Diff 27764.Feb 22 2018, 10:36 AM
  • Revert includes coding style
This revision was automatically updated to reflect the committed changes.