Project

General

Profile

マニュアル #3999

ドキュメントの生成手順

Added by kanehiro over 4 years ago. Updated over 4 years ago.

Status:
終了
Priority:
通常
Assignee:
Target version:
-
Start date:
03/27/2017
Due date:
% Done:

100%

Estimated time:

Description

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

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

Associated revisions

Revision 3031 (diff)
Added by kawauchi over 4 years ago

[merge] r2892 has been merged from trunk.

Revision 3034 (diff)
Added by kawauchi over 4 years ago

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

Revision 3034 (diff)
Added by kawauchi over 4 years ago

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

History

#1 Updated by n-ando over 4 years ago

  • Status changed from 新規 to 解決
  • % Done changed from 0 to 100

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

#2 Updated by kanehiro over 4 years ago

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

#3 Updated by n.kawauchi over 4 years ago

河内です。

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

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

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

#4 Updated by kanehiro over 4 years ago

河内様、

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

#5 Updated by n.kawauchi over 4 years ago

金広様

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

エラーを拝見すると、以下の修正が反映されていないように思えます。
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 Updated by kanehiro over 4 years ago

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

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

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

#7 Updated by n.kawauchi over 4 years ago

こちらの状況をお知らせします。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 Updated by kanehiro over 4 years ago

  • Status changed from 解決 to 終了

河内様、

$ make
$ make install

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

#9 Updated by n.kawauchi over 4 years ago

金広様

お手数をおかけして、申し訳ございませんでした。原因が分かりました。
ご指摘のエラーは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 Updated by kanehiro over 4 years ago

河内様、

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

#11 Updated by n.kawauchi over 4 years ago

金広様

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

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

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

#12 Updated by kanehiro over 4 years ago

河内様、

./build/autogen; make install

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

Also available in: Atom PDF