プロジェクト

全般

プロフィール

マニュアル #3999

ドキュメントの生成手順

kanehiro約7年前に追加. 6年以上前に更新.

ステータス:
終了
優先度:
通常
担当者:
対象バージョン:
-
開始日:
2017/03/27
期日:
進捗率:

100%

予定工数:

説明

ドキュメントの正しい生成手順を教えて頂けますでしょうか。
以前はdocsの下でmake installでよかったと思うのですが、いつからかそれだとdoxygen_classref.confがない、と言われるようになったと思います。
make doxygen_classref.conf
すれば生成されるのはわかっているのですが、正しい手順を確認したいと思います。

make_dist.log (227 KB) make_dist.log kanehiro, 2017/08/30 13:44

関係しているリビジョン

リビジョン 3031 (差分)
kawauchi が6年以上前に追加

[merge] r2892 has been merged from trunk.

リビジョン 3034 (差分)
kawauchi が6年以上前に追加

[compat,document] Modification of revision 3025, 3030, 3032 have been added manually. refs #3999

リビジョン 3034 (差分)
kawauchi が6年以上前に追加

[compat,document] Modification of revision 3025, 3030, 3032 have been added manually. refs #3999

履歴

#1 n-ando約7年前に更新

  • ステータス新規 から 解決 に変更
  • 進捗率0 から 100 に変更

make dist
でソースパッケージ作成の過程でクラスリファレンスが生成されます。

#2 kanehiro約7年前に更新

make dist
する際にqkcなるコマンドが必要なようなんですが、このコマンドはどのパッケージに入ってますでしょうか?

#3 n.kawauchi6年以上前に更新

河内です。

こちらも対応が遅くなり、申し訳ございません。
make dist時に必要なqkcのインストールですが、私は下記手順にて行っています。

$ wget http://hp.vector.co.jp/authors/VA000501/qkcc100.zip
$ unzip qkcc100.zip
$ make
$ sudo cp qkc /usr/local/bin

よろしくお願いいたします。

#4 kanehiro6年以上前に更新

河内様、

qkcをインストールし、make distを試したところ添付のようにエラーになってしまいました。
何が問題でしょうか。
なお、RELENG_1_1のソースを使用しています。

#5 n.kawauchi6年以上前に更新

金広様

返事が遅くなり申し訳ございません。

エラーを拝見すると、以下の修正が反映されていないように思えます。
OpenRTM-aist/branches/RELENG_1_1 ⇒r2793
OpenRTM-aist/tags/RELEASE_1_1_2 ⇒r2794

これは下記チケットの修正です
http://redmine.openrtm.org/issues/3696

私の方で下記から最新版をチェックアウトしてビルドしたところ正常にビルドできました。
http://svn.openrtm.org/OpenRTM-aist/branches/RELENG_1_1/OpenRTM-aist/

以上、よろしくお願いいたします。

#6 kanehiro6年以上前に更新

svn update
した時に表示されるリビジョンは3029となっています。
ビルドの手順が間違っているのでしょうか。
こちらでは

./build/autogen
./configure --without-doxygen

としていました。--without-doxygenをつけていることが問題かと思い、これを外したところ、
「doxygen_classref.confをmakeするルールがありません」、というエラーになります。

#7 n.kawauchi6年以上前に更新

こちらの状況をお知らせします。OpenRTM-aist/branches/RELENG_1_1をチェックアウトしてのビルドです。
branchesのソース利用なら下記のようにr2793、tagsソースならr2794の修正が入っているでしょうか。

$ svn update
Updating '.':
リビジョン 3029 です。
$ svn -l 2 log
------------------------------------------------------------------------
r3027 | n-ando | 2017-08-30 12:02:35 +0900 (2017年08月30日 (水)) | 1 line

[compat,build] Adding -C/-p option to header install command. refs #4032
------------------------------------------------------------------------
r2793 | kawauchi | 2016-10-28 17:28:34 +0900 (2016年10月28日 (金)) | 1 line

[merge] r2791-2792 has been merged from trunk.
------------------------------------------------------------------------
$ ./build/autogen
$ ./configure --prefix=/usr
$ make dist

上記にてビルドOKです。

#8 kanehiro6年以上前に更新

  • ステータス解決 から 終了 に変更

河内様、

$ make
$ make install

だとclassref.confがない、というエラーが発生する。予めmake distしておくとエラーが発生しないということがわかりました。
ありがとうございました。

#9 n.kawauchi6年以上前に更新

金広様

お手数をおかけして、申し訳ございませんでした。原因が分かりました。
ご指摘のエラーはtrunkでは修正済みですが、これをbranches/RELENG_1_1へ
マージしておりませんでした。

trunkでは下記チケットで対応済みです。
#3887

このチケットで、原因は #3696 の修正によるものと書いています。

#3696 のコミットログは、[compat,->RELENG_1_1]としているので、
#3887 も同じにすべきところをRELENG_1_2としてマージしておりませんでした。
対応が至らず、申し訳ございませんでした。

branches/RELENG_1_1へマージし、make, make installでもエラーが出ない
ことを確認しました。

よろしくお願いいたします。

#10 kanehiro6年以上前に更新

河内様、

make; make install
でビルド、インストールできることを確認しました。
ただ、いきなり
make install
すると同じエラーでコケるようです。特に理由がなければいきなりmake installでもビルドとインストールができたほうが良いと思うのですがいかがでしょうか。

#11 n.kawauchi6年以上前に更新

金広様

#4173 にてtrunkソースへ対応しました。
これをbranches/RELENG_1_1へマージしたかったのですが、すでにdocs/Makefile.amには
RELENG_1_2用の修正が入っており、競合の編集が難しかったため、 r3034 にて手動で
追加しました。

また、今回の修正でタグファイルにも対応しました。
ドキュメント生成時、docs下にOpenRTM-aist.tag, OpenRTM-aist-IDL.tagが出力されます。

よろしくお願いいたします。

#12 kanehiro6年以上前に更新

河内様、

./build/autogen; make install

でドキュメント含めビルド、インストールできることを確認しました。
ありがとうございました。

他の形式にエクスポート: Atom PDF