MySQL의 소스 코드에는 Doxygen을 사용해 작성된 내부 문서가 상당히 많이 포함되어 있습니다. 이 Doxygen 콘텐츠는 https://dev.mysql.com/doc/index-other.html에서 온라인으로 확인할 수 있으며, MySQL 소스 배포판을 통해 로컬 환경에서 직접 생성할 수도 있습니다. 이 글에서는 로컬에서 Doxygen 문서를 생성하는 전체 과정을 단계별로 살펴보겠습니다.
1단계: Doxygen 설치
가장 먼저 해야 할 일은 Doxygen 1.8.11 이상 버전을 설치하는 것입니다. 공식 배포판은 https://www.doxygen.nl/에서 다운로드할 수 있습니다.
설치가 완료되면 버전 번호를 반드시 확인하세요. 아래 명령어로 간단하게 검증할 수 있습니다.
shell> doxygen --version 1.8.13
2단계: PlantUML 설치
다음은 PlantUML을 설치하는 단계입니다. Windows 10 환경에서 설치할 경우, 레지스트리 키가 올바르게 생성되도록 최소 한 번은 관리자 권한으로 실행해야 합니다.
관리자 콘솔을 연 뒤 아래 명령어를 실행합니다.
shell> java -jar path-to-plantuml.jar
명령을 실행하면 콘솔에 오류 메시지 없이 GUI 창이 열려야 정상입니다.
실행 확인이 끝나면 PLANTUML_JAR_PATH 환경 변수를 PlantUML이 설치된 경로로 설정해야 합니다. 설정 예시는 다음과 같습니다.
shell> export PLANTUML_JAR_PATH=path-to-plantuml.jar
3단계: Graphviz 설치
세 번째 단계는 Graphviz의 dot 명령을 설치하는 것입니다. Graphviz는 다이어그램 생성에 필수적인 도구입니다.
설치 후에는 dot 명령이 정상적으로 동작하는지 확인해야 합니다. 아래 명령어를 차례로 실행해 보세요.
shell> which dot /usr/bin/dot shell> dot -V dot - graphviz version 2.28.0 (20130928.0220)
확인이 완료되면 MySQL 소스 배포판의 최상위 디렉터리로 이동한 뒤, 빌드 디렉터리를 만들고 cmake를 실행합니다.
shell> cd your-mysql-source-directory shell> mkdir bld shell> cd bld shell> cmake ..
여기서 cmake가 먼저 실행되며, 이후 단계를 위한 빌드 환경이 준비됩니다.
4단계: Doxygen 문서 생성
모든 준비가 끝났다면 이제 실제로 Doxygen 문서를 생성할 차례입니다. 아래 명령어 하나로 빌드가 진행됩니다.
shell> make doxygen
빌드가 완료되면 반드시 오류 로그를 확인하세요. 오류 로그는 최상위 디렉터리에 생성되는 doxyerror 파일에서 확인할 수 있습니다.
빌드가 문제없이 완료되었다면, 생성된 문서를 웹 브라우저로 열어 결과를 확인할 수 있습니다.
shell> firefox doxygen/html/index.html
브라우저에서 index.html이 정상적으로 표시되면, MySQL 내부 구조를 설명하는 Doxygen 문서를 로컬에서 자유롭게 활용할 수 있습니다.