Details
- Reviewers
ngraham michaelh - Group Reviewers
Baloo - Maniphest Tasks
- T7843: Documentation
- Commits
- R293:580d2feff619: Clean up existing documentation
Diff Detail
- Repository
- R293 Baloo
- Branch
- doc-cleanup
- Lint
No Linters Available - Unit
No Unit Test Coverage
README.md | ||
---|---|---|
27 | The icon/badge is Oh, and keep it at the top of the section |
- Apply suggested changes
- Add KFileMetaData link
- Correct new bug links
- Change recommendation text
README.md | ||
---|---|---|
33 ↗ | (On Diff #31668) | If I understood R293:49fecea8e218ce03b01073c1604cfc0b683b1cc5 correctly baloo is a stub for every system except linux. |
README.md | ||
---|---|---|
33 ↗ | (On Diff #31668) | 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 it may run on other unix based systems. It is not tested and therefore not recommended." ? |
README.md | ||
---|---|---|
33 ↗ | (On Diff #31668) | "Baloo is developed and tested exclusively for 64-bit Linux and FreeBSD. It may run on other unix based systems. On those it should be thoroughly tested as Baloo may affect system stability. Baloo may run on 32-bit systems, but also may not work correctly. Please..." (Is there a better way to collaborate on texts? This is tedious and not very effective. @ngraham?) |
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.
README.md | ||
---|---|---|
33 ↗ | (On Diff #31668) | 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 file searching solutions that integrate better than Baloo can." |
README.md | ||
---|---|---|
33 ↗ | (On Diff #31668) |
If Baloo has to be present for the dependency, it makes no sense to recommend not packaging it. That, or I got it wrong. |
README.md | ||
---|---|---|
33 ↗ | (On Diff #31668) | Thats my understanding of the code as well. |
I think these changes are a sufficient improvement to push it as is, we can do more fixups later.
@ngraham - your opinion?