[plamo:11497] Re: Plamo Documents Project

[Chie Nakatani]

  加藤泰文 さん、こんにちは

  > >   > # viewcvs を入れるとか．:-)
  > > 何かよい方法を考えましょ
  > 
  > HTML 形式の文書があるのなら，公開はしやすいですね．:-)

 HTML 形式の文書 でも途中経過が見られるほうが良いですね。

  > > とりあえずは、参加方法と、簡単な cvs の使い方くらいでよいですよね。
  > 
  > この辺りよく分からないのですが，sgml とかの形式で文書を書く必要がある
  > んですよね? その辺りで書く前にインストールしておいた方が良いプログラム
  > とかあるのなら，その方法とか，その情報へのポインタとか示しておいてもら
  > うと，さっぱりわけの分かってない人にはありがたいかも知れません．

訂正とか修正とか、ちょっとしたことなら、このメーリングリストに書いて頂
ければ、できる人がもとファイルを修正するのは別に問題ないと思います。

とりあえず簡単ですが、使い方
html もできますので、あとでどこかに置きます。

--------------------------------------
<!doctype linuxdoctr system>
<article>
<title>Plamo CVS メモ </title>
<author>Chie Nakatani
<date>26 Sep 2001

<abstract>
これは plamo linux のための文書整理用 cvs を使うためのメモです。
</abstract>

<toc>




<sect>cvs の committer になるには
<p>

こじまさんに連絡を取り、cvs のアカウントを発行してもらいます。
kojima@linet.gr.jp

自分のマシンに cvs と ssh をインストールしておきましょう。
plamo 2.2 以降の CD-ROM をお持ちなら、
<p>
/cdrom/contrib/Network/cvs.tgz,openssh.tgz,openssl.tgz

ssh は次のところからも入手できます。
<htmlurl url="http://www.openssh.com/portable.html"; name="http://www.openssh.com/portable.html";>

以上の準備ができたら、
<tscreen><verb>
% setenv CVSROOT plamo.linet.gr.jp:/home/cvs
% setenv CVS_RSH ssh
% cvs co Plamodocs
</verb></tscreen>

あるいは bash をお使いなら、
<tscreen><verb>
$ export CVSROOT=":ext:plamo.linet.gr.jp:/home/cvs"
$ export CVS_RSH="ssh"
$ cvs co Plamodocs
</verb></tscreen>

/etc/profile に次の記述を加えておくと便利です。
<tscreen><verb>
export CVSROOT=":ext:plamo.linet.gr.jp:/home/cvs"
export CVS_RSH="ssh"
</verb></tscreen>

$ cvs co Plamodocs というコマンドで cvs レポジトリにあるファイルが入手でき
ます。

手もとのマシンのホームディレクトリに専用の作業ディレクトリを作っておくと
便利です。



<sect>CVS の使い方
<p>


<sect1>全体的な注意
<p>
commit しようとするファイルが euc で書かれているかを確認しておきます。
<p>
nkf -e xxx > xxx-e などで euc に変換する。


<sect1>文書を新規登録する場合
<p>
Plamodocs/ に入り、登録する文書のディレクトリを作成します。
(たとえば、いま、PlamoCVS-FAQ という文書を新規登録する場合)

<tscreen><verb>
$ mkdir PlamoCVS-FAQ
    (今後のPlamo cvs での文書管理を考慮して、現在は、
     ディレクトリは必要に応じて作成。)
$ cvs add PlamoCVS-FAQ
    (ディレクトリを作った場合は、 cvs add するのを忘れないように)
</verb></tscreen>

Plamodocs/PlamoCVS-FAQ に入り、commit します。

$ cvs commit -m 'PlamoCVS-FAQ.sgml: added' PlamoCVS-FAQ.sgml



<sect1>文書を更新する場合
<p>
必ず、手もとのファイルを更新します。

<tscreen><verb>
$ cvs upd some-file1 some-file2 ...
ディレクトリごと更新する場合は、
$ cvs upd some-dir

変更後、commit する
$ cvs commit -m 'xxxxx.sgml: updated' xxxxx.sgml
</verb></tscreen>


注意 
<itemize>
<item>cvs commit -m の 'message' の記述について
     cvs commit &lt;filename&gt; で commit しても別に問題はないです。

     'message'の書き方には特に決まりはないので、
     なにをしたか (added, updated, typo fix, ...) を記すようにします。
<item>Change.Log に自分が行った変更を簡単にまとめて記しておくようにします。

</itemize>


<sect>参考
<p>
cvs、sgml については次のところを参考にしてください。

<itemize>
<item><htmlurl url="http://www.linux.or.jp/JF/workshop/guidance-sgml.html"; name="http://www.linux.or.jp/JF/workshop/guidance-sgml.html";>

<item><htmlurl url="http://www.linux.or.jp/JF/workshop/linuxdoc-sgml/FAQj.html"; name="http://www.linux.or.jp/JF/workshop/linuxdoc-sgml/FAQj.html";>

<item><htmlurl url="http://www-vox.dj.kit.ac.jp/nishi/cvs/cvs.html"; name="http://www-vox.dj.kit.ac.jp/nishi/cvs/cvs.html";>

<item>UNIX MAGAZINE 2001 １月号	CVS によるバージョン管理
<item>UNIX MAGAZINE 2001 ２月号	ネットワーク環境での CVS の利用
</itemize>


</article>
-----------------------------------------

中谷千絵