Uploaded image for project: 'RHEL'
  1. RHEL
  2. RHEL-68696

Remove generated html content from llvm-doc subpackage [rhel-9]

    • Icon: Story Story
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • rhel-9.6
    • rhel-9.6
    • llvm
    • None
    • llvm-19.1.5-2.el9
    • None
    • 1
    • rhel-sst-pt-llvm-rust-go
    • ssg_platform_tools
    • 1
    • False
    • Hide

      None

      Show
      None
    • Yes
    • SST LLVM/Rust/Go Sprint 14
    • Unspecified Release Note Type - Unknown
    • None

      If possible, we should remove the llvm-doc component, and only ship manpages (which are part of the main llvm package), but not HTML docs. The LLVM HTML documentation is available online, and I believe it is very unlikely that anybody is using the packaged documentation.

      Building the documentation has some overhead:

      • We carry a RHEL-only cmake patch to remove the myst_parser dependency.
      • The big-merge branch carries a patch to allow not building the lldb docs while still building llvm docs. It also does various after-the-fact cleanup to remove other built documentation (clang, lld).
      • RHEL 8 converts markdown to rst using pandoc. This is not done on RHEL 9 / 10, and I'm not sure why, because I'd expect it to be necessary there as well. It's possible that building the markdown pages just doesn't work there.

      It would be ideal if we could drop the llvm-doc subpackage (marked obsoleted by the main package) in all RHEL versions.

       

      DECISION: We keep the llvm-doc package, but replace its contents with a single html file pointing to upstream documentation.

              kkleine Konrad Kleine
              tstellar@redhat.com Thomas Stellard
              Thomas Stellard Thomas Stellard
              Jesus Checa Hidalgo Jesus Checa Hidalgo
              Marc Muehlfeld Marc Muehlfeld
              Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

                Created:
                Updated: