hhvm man page generates incorrectly due to ronn parser bug
- Dominant language
- C++
- Stars
- 18.7k
- Forks
- 3.1k
- Avg merge
- 1h 47m
- Merged PRs (30d)
- 2
Description
Because of https://github.com/rtomayko/ronn/pull/65
It creates the file incorrectly
https://github.com/facebook/hhvm/blob/master/hphp/doc/man/hhvm.1#L110
such that line 110 looks like a macro to man.
I could submit a PR to fix it myself, but @Jo-Con-El wants to try to fix the ronn source,
which is not actually included in the HHVM repository (likely due to ruby dependency).
Just posting a ticket, so it it doesn't get lost in the shuffle.
NOTE: ronn seems unmaintained, maybe there is something nice in python
that can handle this task instead.
Contributor guide
Research direction
Start by inspecting hphp/doc/man/hhvm.1 around line 110 and trace how the HHVM man page is generated with ronn. Review rtomayko/ronn pull request 65 and the external ronn dependency; done means the generated page no longer treats that line as a man macro, whether by fixing ronn or selecting a replacement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100