Bug 1839024
| Summary: | fossil-doc is useless | ||
|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Van de Bugger <van.de.bugger> |
| Component: | fossil | Assignee: | Dan Čermák <dan.cermak> |
| Status: | CLOSED ERRATA | QA Contact: | Fedora Extras Quality Assurance <extras-qa> |
| Severity: | medium | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 32 | CC: | divya.hariomtatsat, petasisg, shngmao |
| Target Milestone: | --- | ||
| Target Release: | --- | ||
| Hardware: | All | ||
| OS: | All | ||
| Whiteboard: | |||
| Fixed In Version: | fossil-2.12.1-2.fc32 | Doc Type: | If docs needed, set a value |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2021-02-12 01:47:53 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
Van de Bugger
2020-05-22 10:55:23 UTC
This package has changed maintainer in the Fedora. Reassigning to the new maintainer of this component. This package has changed maintainer in the Fedora. Reassigning to the new maintainer of this component. Actually there are two solutions for this: 1. use newly built fossil to create a new fossil repo and add `www` folders to fossil. This is easier and can be implemented in RPM 2. current fossil supports `wiki export -html` command, which generates HTML pages. But this method can only support wiki/technote objects. Project Documentation/embedded doc [0] is not supported. But I can implement that in fossil and try to commit to upstream (take longer). [0]: https://www.fossil-scm.org/home/doc/trunk/www/embeddeddoc.wiki Sheng has kindly provided a fix that has been pushed to Rawhide. Could you take a look if this is sufficient for you? I took a look at fossil-doc-2.12.1-2.fc34.x86_64.rpm.
1. fossil-doc package does not require fossil package, while fossil executable is required to view the documentation. I think "Requires: fossil" or "Recommends: fossil" should be added to fossil-doc.
2. It is assumed that user should execute "fossil ui /usr/share/doc/fossil-doc/fossil-doc.fossil" in order to view the documentation. It is written in the package description, but who reads the package description when the package is already installed? I guess method to view fossil documentation is not obvious for fossil newbies. Consider adding a helper script /usr/bin/fossil-doc like this one
#!/bin/sh
exec /usr/bin/fossil ui "$@" /usr/share/doc/fossil-doc/fossil-doc.fossil
or adding a kind of README
Documentation in repository format for fossil. Users can run `fossil ui`
in /usr/share/doc/fossil-doc folder to view documents in browser.
to /usr/share/doc/fossil-doc directory.
3. Search does not work for me. Run
$ fossil ui --page doc/trunk/www/permutedindex.html /usr/share/doc/fossil-doc/fossil-doc.fossil
then enter something in the input field and press "Search Docs" button. I see "Search is disabled" warning in red color after that.
4. Is fossil checkout really required? I tried to remove .fslckout file and www directory from /usr/share/doc/fossil-doc, and /usr/bin/fossil ui /usr/share/doc/fossil-doc/fossil-doc.fossil still works.
Hi Van de Bugger, thank you for the comments! To conclude your suggestion: - add dependencies for fossil-doc - turn on searching/indexing - create a script to run fossil, then no checked-out files are needed. I agree with all three of them and will prepare a pull-request for defolos to review. Hi Van de Bugger, Please check this pull-request for the updates: https://src.fedoraproject.org/rpms/fossil/pull-request/3 and pre-built COPR packages can be found at https://copr.fedorainfracloud.org/coprs/ivzhh/fossil/build/1839472/ Hi, I checked fossil-doc-2.13-2.fc33.x86_64.rpm found at https://copr.fedorainfracloud.org/coprs/ivzhh/fossil/build/1839472/. It looks good. Thank you Van de Bugger! I will contact Dan for final review. FEDORA-2021-77648a0793 has been submitted as an update to Fedora 32. https://bodhi.fedoraproject.org/updates/FEDORA-2021-77648a0793 FEDORA-2021-77648a0793 has been pushed to the Fedora 32 testing repository. Soon you'll be able to install the update with the following command: `sudo dnf upgrade --enablerepo=updates-testing --advisory=FEDORA-2021-77648a0793` You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2021-77648a0793 See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates. FEDORA-2021-77648a0793 has been pushed to the Fedora 32 stable repository. If problem still persists, please make note of it in this bug report. |