CVS Log Report

cvs repository 를 운영할 때 도움이 되는 tip 입니다.

 준비물
* CVS Repository
* cvsweb 혹은 viewcvs

------------------------------------------------------------------------------------------------
* CVSROOT 둘러보기

cvs repository 를 init 로 Repository를 하나 만들게 되면, 환경변수 $CVSROOT 를
CVS Root라고 할 때, 그 하위에 CVSROOT 라는 디렉토리가 하나 생깁니다. 이
디렉토리($CVSROOT/CVSROOT)는 cvs에 commit 할 때 여러가지 훅(?) 등을 설치할 수
있게 됩니다. 그리고 그 안의 파일들을 보면 아래와 같은 모습으로 되어 있는데,
",v" 파일들은 cvs,rcs에서 사용하는 버전 control 용 정보가 들어 있는 파일들이며,
개정이력들이 그대로 들어 있는 파일이지요.

checkoutlist
checkoutlist,v
commitinfo
commitinfo,v
config
config,v
cvsignore
cvsignore,v
cvswrappers
cvswrappers,v
editinfo
editinfo,v
loginfo
loginfo,v
modules
modules,v
notify
notify,v
rcsinfo
rcsinfo,v
taginfo
taginfo,v
verifymsg
verifymsg,v

CVSROOT도 하나의 모듈로써 관리를 할 수 있습니다. kldp.net에서 cvs를 사용해
보셨다면, 각 project의 CVSROOT 만들어지고, 기본적으로 CVSROOT라는 디렉토리와
project name에 해당하는 디렉토리 두 개가 기본적으로 주어지게 될 것입니다.

http://cvs.kldp.net/cgi-bin/cvsweb.cgi/?cvsroot=hserver

이 때 CVSROOT/* 의 파일들을 수정하려면

cvs checkout CVSROOT

라는 방법으로 가져오고 다시 commit 하면 되는 것입니다. 하지만 여기에서 주의할
것은, commit 하면, 모든 파일들은 단지 "*,v" 파일로 올라가게 되는데,
CVSROOT에서만큼은 기본적인 파일들은 $CVSROOT/CVSROOT 즉, 같은 위치에 바로
checkout 을 해놓기 때문에 ,v 없는 즉 working directory에 있는 꼴의 마지막
버전이 존재하게 됩니다.

따라서 만일 CVSROOT에 어떤 파일들을 추가할 경우 그 파일도 ",v"로 올라가게되므로
원하는 것을 하려면, 같은 자리에 checkout 되도록 해야하는데, 이때 넣어 주는
것이 checkoutlist 라는 파일을 편집해야하는 것입니다.

예를 들어 cvsreport 라는 shell script를 하나 추가한다면

$ cat checkoutlist

# The "checkoutlist" file is used to support additional version controlled
# administrative files in $CVSROOT/CVSROOT, such as template files.
#
# The first entry on a line is a filename which will be checked out from
# the corresponding RCS file in the $CVSROOT/CVSROOT directory.
# The remainder of the line is an error message to use if the file cannot
# be checked out.
#
# File format:
#
#       [<whitespace>]<filename><whitespace><error message><end-of-line>
#
# comment lines begin with '#'
cvsreport               Check error message

------------------------------------------------------------------------------------------------
* Web base CVS viewer

이런 종류의 module에는 cvsweb (perl), viewcvs (python) 등이 있습니다.

http://stud.fh-heilbronn.de/~zeller/cgi/cvsweb.cgi/
http://viewcvs.sourceforge.net/

viewcvs 가 cvsweb의 interface를 그대로 받았기 때문에 외관으로 보이는 것은 거의
같습니다. 이 들을 선택하는 기준은 여러가지가 있겠습니다만, 논외로 하고, 둘
중하나가 설치되었다고 가정하겠습니다.

제가 선호하는 것은 viewcvs + enscript + cvsgraph 조합입니다.
syntax coloring과 revision tree를 graph로 보이는 기능이 들어가죠.

------------------------------------------------------------------------------------------------
* Loginfo

이 툴에서 제공하는 것 중에, revision diff 가 있습니다. 두 버전의 차이를 웹
상에서 비교해주는 것입니다.

http://cvs.kldp.net/cgi-bin/cvsweb.cgi/hserver/src/hserverstd.h.diff?r1=1.1&r2=1.2&cvsroot=hserver

이 URL이 cvs commit 할 때 자동으로 메일로 전송되면, 같은 프로젝트팀원들이
조금만 관심을 가져주게 되면, 소스의 변경을 계속 추적할 수 있게 됩니다. loginfo
를 다음과 같이 수정하고 cvsreport를 CVSROOT에 추가하는 것으로 가능하게 됩니다.

loginfo

DEFAULT         $CVSROOT/CVSROOT/cvsreport %{sVv}

cvsreport

#!/bin/sh
# viewcvs diff url reporter.
# Made by Hojin Choi
# Last modified: 2003. 8.

#--System configuration..
CVSURL="http://172.16.100.111/cgi-bin/viewcvs.cgi"

#--viewcvs--
CVSDIFFOPTION="diff_format=l"
CVSMARKUPCONTENTTYPE="text/vnd.viewcvs-markup"

#--cvsweb--
#CVSDIFFOPTION="f=H"
#CVSMARKUPCONTENTTYPE="text/x-cvsweb-markup"

#--Multi rooted environment
SUBROOT=

if [ -z "${SUBROOT}" ]; then
SUBROOTENC=""
else
SUBROOTENC="cvsroot=${SUBROOT}&"
fi

#--Mail sender (in HP, MAILER=mailx)
MAILER=mail

#--Temporary file format
TMPCVSREPORT="${CVSROOT}/tmpcvsreport.$$"

rm -f ${TMPCVSREPORT}

echo "Committed by ${USER}" >> ${TMPCVSREPORT}
echo "--------------------------------------------------------" >> ${TMPCVSREPORT}
#Append cvs orginal log
cat >> ${TMPCVSREPORT}
module=

report_file()
{
        file="$1"
        old="$2"
        new="$3"
        if [ "${old}" = "NONE" ]; then
                printf "N %-15s: %s\n" "${file}" "${CVSURL}/${module}/${file}?${SUBROOTENC}rev=${new}&content-type=${CVSMARKU
PCONTENTTYPE}" >> ${TMPCVSREPORT}
        elif [ "${new}" = "NONE" ]; then
                printf "D %-15s: %s\n" "${file}" "${CVSURL}/${module}/${file}?${SUBROOTENC}rev=${old}&content-type=${CVSMARKU
PCONTENTTYPE}" >> ${TMPCVSREPORT}
        else
                printf "M %-15s: %s\n" "${file}" "${CVSURL}/${module}/${file}.diff?${SUBROOTENC}r1=${old}&r2=${new}&${CVSDIFF
OPTION}" >> ${TMPCVSREPORT}
        fi
}

for filerev in $@
do
        if [ -z "${module}"  ];
        then
                module=${filerev}
                echo "Module    : ${filerev}" >> ${TMPCVSREPORT}
                if [ -z "${SUBROOTENC}" ]; then
                        echo "Module url: ${CVSURL}/${module}/" >> ${TMPCVSREPORT}
                else
                        echo "Module url: ${CVSURL}/${module}/?${SUBROOTENC}" >> ${TMPCVSREPORT}
                fi
                echo "" >>${TMPCVSREPORT}
                continue
        fi
        if [ "${filerev}" = "-" ];
        then
                break
        fi
        SAVEIFS="$IFS"
        IFS=,
        report_file ${filerev}
        IFS="${SAVEIFS}"
done

subject="CVS REPORT: '${module}' update"

case "${module}" in
CVSROOT*)
        receiver="userid(AT)domain.ccom"
        ;;
*)
        receiver="userid(AT)domain.ccom"
        ;;
esac

receiver="`echo ${receiver} | sed -e 's/(AT)/@/g'`"
${MAILER} -s "${subject}" ${receiver} < ${TMPCVSREPORT}
rm -f ${TMPCVSREPORT}

------------------------------------------------------------------------------------------------

이상으로 설정해 놓고, 윗부분에 해당하는 환경설정과 mail 수신할 수신자를
수정하시면, 원하는 report를 받을 수 있을 것입니다. 제가 사용하는 것을
kldp.net에 맞게 수정하느라 많이 고친 곳이 있는데, 지금은 거의 일반화 되어
아무데서나 사용할 수 있을 모양으로 되었습니다.
노파심에서 강조합니다만, Repository의 CVSROOT 에 직접들어 가서 파일 수정하지 마시고,
checkout 한 CVSROOT 를 수정하여 올리시길 바랍니다.

즐거운 CVS Life가 되시길 바랍니다.
코드 수정이나 의견은 항상 환영합니다.

------------------------------------------------------------------------------------------------
이런 일을 하는 공개 소스가 더러 있더군요. 많이 찾아 보질 않아서 얼마나 있는지는 잘 모르겠습니다만,
viewcvs 를 개발하는 곳의 CVS만 해도 log_accum.pl 이라는 것을 사용합니다.

http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/viewcvs/CVSROOT/log_accum.pl?rev=1.2&content-type=text/vnd.viewcvs-markup

------
약간 스크립트를 수정하였습니다.