dasom-im / dasom

Dasom is a multilingual input method framework
https://dasom-im.github.io
GNU Lesser General Public License v3.0
12 stars 3 forks source link

add manpage #51

Closed minwook-shin closed 8 years ago

ghost commented 8 years ago

https://github.com/minwook-shin/dasom/commit/ff114c621641e5508e27d169476de9fdfae0bc01 이 커밋 이미 제가 작성하여 병합된 코드입니다. 불필요한 커밋입니다.

https://github.com/minwook-shin/dasom/commit/c3bcdec6ad14db276a79b0bee6a50cb5ff95c9da 이 커밋은 manpage 를 추가하는 커밋인데..

configure.ac 파일에 공백 라인은 제거되어야 합니다.

docs/dasom-daemon.1, docs/dasom-indicator.1Contact Hodong Kim <hodong@cogno.org>. Maintainer: Hodong Kim <hodong@cogno.org> 이런 건 제거되어야 할 부분입니다. 그게 있으면 manpage 관련하여 저한테 문의가 오겠죠.

그리고 내용에 잘못된 정보가 있고 혼란스럽습니다.

sukso96100 commented 8 years ago

@cogniti 흠... 닫기 보다는 수정 방향을 제시해 주시는 것이 좋다고 생각합니다. #50 에서 보셨다싶이. 코드 병합 전에 포크된 저장소에 커밋 추가로 하면 자동으로 PR에도 해당 커밋이 포함되거든요.

그리고. ff114c6 이 커밋은 민욱님께서 origin 저장소인 dasom-im/dasom 에 기여를 넣기 위해 dasom-im/dasom 에서 커밋 받아다가 본인 저장소에 병합한 경우 입니다. 민욱님께서 PR 통해서 dasom-im/dasom 의 커밋을 받아 가셨네요.

의견 추가적으로 있으신 경우, 말씀해 주시면 감사하겠습니다.

ghost commented 8 years ago

저장소를 동기화를 다시 하셔야 됩니다. 수정 방향은 이미 제시했습니다.

이 부분은 제거되어야 합니다.

.\" Contact Hodong Kim <hodong@cogno.org>.

아래에 1.3 이라고 있는데.. 이것이 무얼 의미하는지요.

.TH dasom-indicator 1 "January 2016" "1.3" "dasom-indicator man page"

설명이 잘못되어 있습니다. dasom-indicator 는 dasom 을 위한 표시기입니다라는 내용이 들어가야겠죠.

.SH NAME
dasom-indicator \- Input Method Framework

아래는 README 에서 가져온 내용 같은데... 대부분 불필요한 설명입니다. 이것 때문에 혼란스럽습니다. 그리고 기호가 들어갈 필요가 없습니다.

.SH DESCRIPTION
Dasom is an input method framework, which provides
.PP
•Input Method Server
.TP
.PP
◦dasom-indicator including XIM
.PP
•Indicators
.TP
.PP
◦GNOME shell: dasom agent extension
.TP
.PP
◦KDE, Unity, GNOME panel: dasom-indicator (based on libappindicator3)

아래보시면 --no-indicator 라고 있는데.. 이런 옵션은 없습니다. 없는 옵션을 만들어서 넣으셨는데 dasom-indicator도 데몬(daemon)으로 작동하는 프로그램입니다. dasom-indicator --help 하면 --no-daemon Do not daemonize 이 옵션이 나오는데.. 이 옵션 맞는 옵션입니다. 제가 프로그램을 잘못 작성한 것이 아닙니다. 그걸 임의로 --no-indicator Do not indicatorize 이렇게 바꾸신 건데...

.PP
Application Options:
.TP
.PP
--no-indicator
Do not indicatorize
.TP

AUTHOR저자. 작가, 작성자를 의미합니다. 혼동의 여지가 있으므로 이 부분은 manpage 에 들어가지 않는게 좋습니다. Maintainer는 유지보수 관리자를 의미합니다. 거기에 제 이름을 써 놓으셨는데....

.SH AUTHOR
Maintainer: Hodong Kim <hodong@cogno.org>

저장소 동기화부터 다시하고 처음부터 다시 작성하셔야 합니다. manpage 에 대해서는 아래 문서를 참고하시기 바랍니다. 그리고 dasom-daemon, dasom-indicator 은 사용자가 직접 만질 일이 거의 없습니다. dasom-indicatordasom-daemon이 실행 중일 때나 정상 작동하므로, dasom-indicator 를 가동하기 전에 dasom-daemon이 가동 중인지 확인하라는 내용이 들어가면 좋고, 접속이 끊긴 상태의 경우 ! (느낌표) 가 표시된다는 내용이 들어가면 좋습니다.

단순히 --help 하면 나오는 내용을 옮겨 적는 것으로는 manpage 의 의미가 없습니다. Pull Request 을 읽고 검토하는 사람도 상당히 많은 시간을 소비하기 때문에 이 점 감안하셔서 Pull Resquest 하기 전에 충분히 검토하신 후에 PR 하시기 바랍니다.

.TH hwp2txt 1 "30 May 2014"
.SH NAME
hwp2txt \- hwp document to text converter
.SH SYNOPSIS
.B hwp2txt
[OPTIONS]
.I HWP_FILE
.SH DESCRIPTION
converts hwp document file to plain text.
.PP
The
.I HWP_FILE
argument is mandatory.
.SH OPTIONS
.TP
.B \-o, \-\-output\fR=\fIFILE\fR
Write output to \fIFILE\fR and not to standard output.
.TP
.B \-h, \-\-help
Print usage information.
.SH "SEE ALSO"
.BR hwp2pdf (1),
.BR hwp2svg (1),
.BR unhwp (1)
ghost commented 8 years ago

https://github.com/dasom-im/dasom-jeongeum/pull/13 이렇게 PR 을 올렸는데... 년도 수정하는 걸 깜박했습니다. 이 경우, 저장소를 다시 동기화하여 https://github.com/dasom-im/dasom-jeongeum/pull/14 년도 수정후 다시 PR 올리면 커밋 1개로 해결이 됩니다. 위의 manpage 의 경우도 마찬가지로 저장소 동기화를 다시하여 커밋 1개로 합칠 수 있도록 해야겠죠. manpage 을 충분히 검토 후 PR 하면 커밋 1개로 해결할 수 있는데, 검토도 하지 않고 PR 올리고 나서 여기서 검토하고 또 수정하고 또 수정하고 또 수정하고... 이런 식으로 하면 manpage 커밋이 10개 정도 차지할 겁니다. README 커밋을 보더라도 충분히 검토하지 않고 커밋하여 README 파일에 대한 커밋만 5개 정도를 차지하고 있지요. 불필요한 커밋이 늘어나는 것은 바람직하지 않습니다. 자세한 내용은 형상 관리에 대해 알아보시면 되겠습니다.