バグレポートの記述方法(バグレポートアイテムを更新する)- GLOBALBASE PROJECT | POWERD BY HIROHISA MORI

GLOBALBASEマニュアル集 >> マニュアル環境とマニュアルの書き方 >> バグレポートの記述方法(バグレポートアイテムを更新する)
2007-11-04版

バグレポートの記述方法(バグレポートアイテムを更新する)

著者:　森　洋久 / joshua＠globalbase.org 　※　

* 概要
* この作業に必要となる知識
* この作業の前提となるシステム用件
* [ステップ1] 更新するバグレポートアイテムを決める
* [ステップ2] バグレポートアイテムの編集
* [ステップ3] バグ解決時の処理
* [ステップ4] コンパイル
* [ステップ5] HTMLおよびPDFの確認
* [ステップ6] HTMLの公開
* [ステップ7] CVSチェックイン

概要

バグレポートの記述方法は、基本的には通常のマニュアルのアップデート ( 「既にあるマニュアルを編集する手順」)と同じですが、ファイル構成が異なっています。そのため、更新作業が異なる部分があります。

▲ページトップへ戻る

この作業に必要となる知識

この手順は、「バグレポートの記述方法(新たなバグレポートを追加する)」を読んでいることを前提とします。

バグを発見し、報告してくれる人物は多いに歓迎です。現在、多くの場合、そのようなレポートは開発者または、GLOBALBASEの各種メーリングリストに寄せられます。このバグレポートはこのような開発者、つまり、CVSをコントロールできるであろう人たちへ寄せられることを前提としています。こういった開発者がこのマニュアルに新たなバグレポートを追加するということを前提としています。

▲ページトップへ戻る

この作業の前提となるシステム用件

本手順は、ソースコードの開発環境をそろえていることを前提としています。以下のファイルの保存場所などは、sourceforge.jpのCVSからコミットしたワークエリアに対する操作を説明しています。sourceforge.jpからのCVSの取得方法等については、文献「GLOBALBASEの開発」を参照してください。

▲ページトップへ戻る

[ステップ1] 更新するバグレポートアイテムを決める

バグをフィックスした、状況を把握したなど、バグレポートアイテムを更新する必要が生じたときは、まずは、ホームページなどで更新するアイテムのバグレポートコードを確定します。

▲ページトップへ戻る

[ステップ2] バグレポートアイテムの編集

バグレポートコードから編集するアイテムファイルがわかります。基本的には、gbs/doc/xml/src/xml/bugs-reports/[バグレポートアイテム].inというファイル名になっています。

レポートを追加したら、statusタグの属性を変更します。特にtype属性は重要です。

reported
バグが報告された段階。
observation
発生状況が技術者により観測され、状況報告された。
inprogress
バグ除去処理中
solved 解決

という四つの段階を表しています。詳しくは、 [UNDEF REF (gb-manuals-tracking--item--status)]を参照してください。

もし、バグがsolved以外の状態であった場合は、次のステップを飛ばし、「コンパイル」へ進んでください。

▲ページトップへ戻る

[ステップ3] バグ解決時の処理

バグ解決時は、バグレポート本体のファイルにおいて、アイテムファイルを読み込んでいる位置を各アーキテクチャのトラッキングから、 [UNDEF REF (bugs-report-solved)]へ移動します。その場合、複数のアーキテクチャで参照されているアイテムはそれら全部を取り除く必要があります。注意してください。

▲ページトップへ戻る

[ステップ4] コンパイル

マニュアルのコンパイルを実行します。ただし、アイテムファイルのみを更新した場合、 mmake がそれを認識しないことがあります。念のため、本体ファイルをタッチすることをお勧めします。


% touch gbs/doc/xml/src/xml/bugs-report.xml

[注意] 念のため本体ファイルをtouchする。

これ以降はマニュアルの更新手続きの「コンパイル」以降と同一の手順となります。


% cd gbs/doc/xml
% mmake

エラーが発生した場合は、エラーに対処してください。発生エラーのリファレンスは、「mmake時エラーリファレンス」です。

▲ページトップへ戻る

[ステップ5] HTMLおよびPDFの確認

生成結果を確認します。ディレクトリ、gbs/doc/xml/man/pdf 内にPDFファイルがあります。gbs/doc/xml/man/html内にHTMLファイルがあります。これらが正しく生成されているかどうか確認します。

▲ページトップへ戻る

[ステップ6] HTMLの公開

現時点では、HTMLの公開は基本的に森洋久が行います。しかし、ここで公開方法について述べます。gbs/doc/xml/man/htmlのディレクトリはCVSにコミットされているディレクトリでもあります。従って、これをそのまま公開すると、CVSという名前の制御ディレクトリまで公開されてしまいます。これを取り除く必要があります。取り除く方法は、


% cd gbs/doc/xml
% ./make.html.sh

という、取り除き用のスクリプト make.html.sh を実行します。これを実行すると、CVSといったディレクトリが取り除かれた公開用ディレクトリ、gbs/doc/xml/man/manが出来ます。このディレクトリを所定のWWWサーバへアップしてください。

[メモ] GLOBALBASEの公式マニュアルページは、http://www.globalbase.org/globalbase/man/ja-index.html ですが、基本的に、このディレクトリを他の場所へアップロードすると他の場所でも公開可能です。しかしその場合検索エンジンの窓は変更しておかないと、検索結果は、かならず公式ホームページへ飛ぶことになります。

▲ページトップへ戻る

[ステップ7] CVSチェックイン

最後に編集したファイルをCVSへチェックインします。開発したソースコードなどがある場合は、一緒にチェックイン出来ます。


% cvs commit -m "manual" gbs

[注意] チェックイン／チェックアウトはワークエリアのルートで行う必要があります。

▲ページトップへ戻る

$GLOBALBASE��AI[v\[XE\tgEFAxvOSOURCEFORGE.JP��QBĂ܂B$