ndmitchell/shake

RFE: add a manpage for shake

Open

#106 建立於 2014年4月11日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)Haskell (631 star) (108 fork)batch import
help wanted

描述

I know there is documention including a manual and --help output, but distros like Debian and Fedora like to have manpage for installed programs.

Is it possible to add a manpage shake (1) to the distribution? I think pandoc is able to generate them from markdown.

If the manpage could be generated from "shake --help" somehow perhaps it would be less work to keep in sync.

貢獻者指南

技術棧
無
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic knowledge of pandocfamiliarity with markdownunderstanding of shake's build system
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
First, check if there is already a manpage directory or a build rule for documentation in the repository (e.g., in Shakefile.hs or Makefile). The issue suggests using pandoc to generate a manpage from markdown or from help output. Investigate the existing help output and check if there is a markdown version of the manual. Then, propose adding a new target in the build system that runs pandoc to convert either the markdown manual or the help output into a manpage format. Consider adding the manpage as part of the installation process (e.g., via cabal or stack).