D12045: Clean up existing documentation

This revision was automatically updated to reflect the committed changes. Closed by commit R293:580d2feff619: Clean up existing documentation (authored by michaelh, committed by bruns). REPOSITORY R293 Baloo CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D12045?vs=31739&id=44774 REVI

D12045: Clean up existing documentation

bruns commandeered this revision. bruns added a reviewer: michaelh. REPOSITORY R293 Baloo BRANCH doc-cleanup REVISION DETAIL https://phabricator.kde.org/D12045 To: bruns, #baloo, ngraham, michaelh Cc: kde-frameworks-devel, ngraham, bruns, ashaposhnikov, michaelh, astippich, spoorun, abra

D12045: Clean up existing documentation

ngraham accepted this revision. ngraham added a comment. This revision is now accepted and ready to land. Yeah, go for it. Such a shame that Michael disappeared. REPOSITORY R293 Baloo BRANCH doc-cleanup REVISION DETAIL https://phabricator.kde.org/D12045 To: michaelh, #baloo, ngraham C

D12045: Clean up existing documentation

bruns added a comment. Herald edited subscribers, added: kde-frameworks-devel; removed: Frameworks. I think these changes are a sufficient improvement to push it as is, we can do more fixups later. @ngraham - your opinion? REPOSITORY R293 Baloo REVISION DETAIL https://phabricator.kd

D12045: Clean up existing documentation

bruns added inline comments. INLINE COMMENTS > michaelh wrote in README.md:36 > - In CI Baloo is fully built and tested for Linux and FreeBSD. > - In CI an untested stub for Windows is build. I think that is to fulfill the > dependencies. > - macOS is not mentioned anywhere (and I don't know any

D12045: Clean up existing documentation

michaelh added inline comments. INLINE COMMENTS > ngraham wrote in README.md:36 > I think the original paragraph was fine, but needed a bit of cleanup and > grammar work. How's this? > > "We recommend not packaging Baloo for Windows or macOS, as both these > operating systems offer their own f

D12045: Clean up existing documentation

ngraham added a comment. Sorry, not aware of a better workflow for now, but yeah, this does not seem ideal. Perhaps real-time chat would be better, during a time when everyone's available. INLINE COMMENTS > michaelh wrote in README.md:36 > "Baloo is developed and tested exclusively for 64-b

D12045: Clean up existing documentation

michaelh added inline comments. INLINE COMMENTS > michaelh wrote in README.md:36 > For FreeBSD everything is built, test are run in CI and pass. For Windows > it's a stub: Only KF5Baloo.dll and KF5BalooEngine.dll. OSX? > > "Baloo is developed and tested exclusively for Linux and FreeBSD. While

D12045: Clean up existing documentation

michaelh added inline comments. INLINE COMMENTS > michaelh wrote in README.md:36 > If I understood R293:49fecea8e218ce03b01073c1604cfc0b683b1cc5 > > correctly baloo is a stub for every system except linux. > In that ca

D12045: Clean up existing documentation

michaelh added inline comments. INLINE COMMENTS > bruns wrote in README.md:36 > AFAIK, on windows only the library is built, but as a stub. > > See: > R293:49fecea8e218ce03b01073c1604cfc0b683b1cc5 > If I understood R29

D12045: Clean up existing documentation

bruns added inline comments. INLINE COMMENTS > README.md:31 > +Baloo is developed and tested exclusively for Linux. While it may run on > other > +unix based systems. It is not recommended, and certainly not tested. > + While it may run on other unix based systems ", it is hardly tested. It is

D12045: Clean up existing documentation

michaelh marked 2 inline comments as done. michaelh added a subscriber: ngraham. michaelh added inline comments. INLINE COMMENTS > README.md:36 > +the native system than Baloo ever will. > + > +Baloo may run on 32-bit systems, but it has not been tested and may not work @ngraham Original text w

D12045: Clean up existing documentation

michaelh updated this revision to Diff 31739. michaelh added a comment. - Apply suggested changes - Add KFileMetaData link - Correct new bug links - Change recommendation text REPOSITORY R293 Baloo CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D12045?vs=31688&id=31739 BRANC

D12045: Clean up existing documentation

bruns added inline comments. INLINE COMMENTS > README.md:27 > +* Baloo follows the > [KDELibs](https://techbase.kde.org/Policies/Kdelibs_Coding_Style) coding > style. > +* [](https://build.kde.org/j

D12045: Clean up existing documentation

michaelh updated this revision to Diff 31688. michaelh added a comment. - Apply suggested changes REPOSITORY R293 Baloo CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D12045?vs=31668&id=31688 BRANCH doc-cleanup REVISION DETAIL https://phabricator.kde.org/D12045 AFFECTED FILE

D12045: Clean up existing documentation

bruns added inline comments. INLINE COMMENTS > README.md:5 > > -Baloo provides file searching and indexing. It does so by maintaining an > index of the contents > -of your files. > +Baloo is the file indexing and file search framework for KDE Plasma. It > focuses on speed and a very small mem

D12045: Clean up existing documentation

michaelh created this revision. michaelh added a reviewer: Baloo. Restricted Application added projects: Frameworks, Baloo. Restricted Application added a subscriber: Frameworks. michaelh requested review of this revision. REPOSITORY R293 Baloo BRANCH doc-cleanup REVISION DETAIL https://ph

D12045: Clean up existing documentation

michaelh added a task: T7843: Documentation. REPOSITORY R293 Baloo REVISION DETAIL https://phabricator.kde.org/D12045 To: michaelh, #baloo Cc: #frameworks, ashaposhnikov, michaelh, astippich, spoorun, ngraham, bruns, alexeymin