Kouhei Sutou
kou****@clear*****
2013年 7月 28日 (日) 23:47:19 JST
須藤です。 In <20130****@www21*****> "[groonga-dev,01551] APIドキュメント作成手順に関してのご質問" on Sun, 28 Jul 2013 22:59:25 +0900, whomb****@motel***** wrote: > 初めまして。whombxと申します。 > 以前からgroongaに興味を持って、使わせて頂いております。 ありがとうございます！ > この度、APIのドキュメント作成に協力したいと思い、 > ブログの記事（http://groonga.org/ja/blog/2013/07/22/api-documentation.html） > の手順を追わせて頂きましたが、 > 確認させて頂きたい点があり、ご連絡いたしました。 とてもとてもありがとうございます！ 助かります！ > まず、pull requestの手順なのですが、 > これは、git://github.com/groonga/groonga.gitのリポジトリに直接、 > 作成したブランチをpushしてしまってよろしいのでしょうか？ > それとも一度、自分のリポジトリにforkするような手順が正しいでしょうか。 > （githubに慣れておらず、常識的なことでしたら恐縮です。 あ、それはできないので、自分のリポジトリにforkしてください！ たぶん、ここがforkしたやつですよね？ https://github.com/whombx/groonga であれば、以下のように作業してもらえると助かります！手順の方 は後で改良しておきます。 最初に一度だけやること: gitの初期設定（もうすでにやっているかも）: % git config --global user.name "whombx" % git config --global user.email "whomb****@motel*****" 手元のリポジトリの初期設定: % git clone git****@githu*****:whombx/groonga.git % cd groonga % git remote add upstream git****@githu*****:groonga/groonga # ↑ groonga本家の最新状態を追いかけるための設定 ドキュメントビルド用の初期設定: % ./autogen.sh % ./configure --enable-document # ↑このあたりでエラーがでるかもしれません。 # エラーがでるようなら環境を教えてもらえますか？ 作業毎にやること: groonga本家の最新状態に追従: % git fetch --all % git checkout master % git rebase upstream/master 関数単位でやること（例えばgrn_ctx_open()をやる場合）: 作業用のブランチを作成: % git checkout -b grn-ctx-open 作業: include/groonga.hから doc/source/reference/api/grn_ctx.txtにドキュメントを移 動する。 ドキュメントを確認: % cd doc/locale/en % make html # ↑doc/source/reference/api/grn_ctx.txtからHTMLを生成 % firefox html/reference/api/grn_ctx.html # ↑いつも使っているブラウザで該当ファイルを確認して、 # 移動した内容が追加されていればOKです！ コミット: % cd ${cloneしたディレクトリーのトップディレクトリー} % git add include/groonga.h % git add doc/source/reference/api/grn_ctx.txt % git commit # コミットメッセージは↓な感じ1行でOKです！ # # doc: move grn_ctx_open() document to Sphinx text from header file pushしてpull request: # ↓「grn-ctx-open」は前の方の作業で作ったブランチ名 % git push -u origin grn-ctx-open （ブラウザで https://github.com/whombx/groonga を開く と「grn-ctx-open」ブランチをpull requestする！みたい なUIができているので、そこのボタンを押してpull requestしてください。入力フォームがでてきますが、コ ミットの情報が書いたもので十分な情報が入っているので そのままpull requestしてOKです！） 「groonga本家の最新状態に追従」に戻って繰り返し。 > また、例として挙げられているgrn_ctx_initの解説が英訳されておらず、 > 英語のドキュメントにおいても日本語で出力されるようですが、 > 英訳の作業は必要でなく、 > ドキュメントのフォーマット化を機械的に行えば良いでしょうか？ はい、必要ありません！ まずは、ヘッダーファイルからSphinxのテキストの方に移動したい です！そうすれば、Visual Studioでの警告を消せるからです。翻 訳はその後でいいと思っています。が、ブログにある手順はそうは 書いていませんね。。。整理しておきます。。。 > 恐れ入りますが、宜しくお願いいたします。 いえいえ、こちらこそ協力してもらってありがとうございます！ ブログに書いているやり方をもっとわかりやすくしたいとも思って いますので、つまづいたところがあれば教えてもらえるとうれしい です！ -- 須藤 功平 <kou****@clear*****> 株式会社クリアコード <http://www.clear-code.com/> (03-6231-7270) groongaサポート: http://groonga.org/ja/support/ パッチ採用はじめました: http://www.clear-code.com/recruitment/ コミットへのコメントサービスはじめました: http://www.clear-code.com/services/commit-comment.html
