Documentation to build gnatdoc
Open
Nobody has claimed this yet.
- Dominant language
- Ada
- Stars
- 6
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
This ticket requests detailed, up-to-date documentation on how to build gnatdoc from source. Problems I've encountered while trying to do this:
- Building gnatdoc from alire works, but produces a non-working binary. (See tickets #35 and #36.)
- Building gnatdoc from cloned github repository seems non-trivial:
- It relies on a Makefile rather than alire or a top-level gpr file.
makefails because it cannot find certain dependencies.- Nothing in the documentation tells you where to find the dependencies.
- One of the dependencies, vss, was recently split into subprojects, and a small amount of digging around leaves me unclear as to:
- where I can obtain the ones needed for gnatdoc
- how I should install them -- presumably in the subprojects folder
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the repository's Makefile and the existing build instructions, then trace the dependencies that make cannot find, including the split vss subprojects and the subprojects folder. Done means documenting where each dependency comes from, how to install it, and a verified working procedure for building gnatdoc from the cloned repository; tickets #35 and #36 provide related context.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100