다음 이전 차례

2. 바람직한 프로젝트 이름과 압축 파일 이름을 짓는 관례

Sunsite와 PSA, CPAN 과 같은 보관소를 유지하는 사람의 작업량이 증가하면서 부분적으로나 전적으로(완전히 사람에 의해서가 아니라) 프로그램에 의한 작업이 증가하는 추세이다.

이러한 상황에서는 파일 분류하는 작업을 하는 컴퓨터 프로그램이 해석하고 이해할 수 있는 규칙적인 형태에 알맞은 프로젝트와 압축 파일의 이름이 중요하게 되었다.

2.1 GNU-스타일의 이름 사용. 접두사-major번호.minor번호.patch번호

당신의 압축 파일이 소문자 알파벳과 숫자로 된 접두사 그 다음 이음선(dash) 그리고 버전 번호, 확장자(extension)와 다른 접미사로 되어 있는 GNU식의 이름을 가지고 있다면 모든 이에게 도움이 될 것이다.

version 1, release 2, level 3 인 `foobar'라는 프로젝트를 가지고 있다고 가정해보자. 만약 그것이 하나의 압축 파일의 한부분(아마 소스겠죠)이라면 압축 파일의 이름은 다음과 같을 것이다.

foobar-1.2.3.tar.gz

소스 압축 파일

foobar.lsm

LSM 파일 (asuming you're submitting to Sunsite).

제발 다음과 같이 사용하지 마라:

foobar123.tar.gz

많은 프로그램에게 `foobar123'이라고 불리는 버전 번호가 없는 프로젝트의 압축 파일처럼 보일 것이다.

foobar1.2.3.tar.gz

많은 프로그램에게 `foobar1'이라고 불리는 버전 2.3 인 프로젝트의 압축 파일처럼 보일 것이다.

foobar-v1.2.3.tar.gz

많은 프로그램이 프로젝트 이름을 `foobar-v1'이라고 생각할 것이다.

foo_bar-1.2.3.tar.gz

밑줄(underscore)은 말하고, 입력하고, 기억하기 힘들다.

FooBar-1.2.3.tar.gz

당신이 바보(marketing weenie)가 아닌 한 이것 또한 말하고, 입력하고, 기억하기 힘들다.

소스와 바이너리 또는 다른 종류의 바이너리를 구분하거나 파일 이름에 어떤 종류의 제작 옵션을 표현하려면 제발 버전 번호 뒤에 오는 파일 확장자(extension)로 설명해라. 그것은 다음과 같이 한다:

foobar-1.2.3.src.tar.gz

소스

foobar-1.2.3.bin.tar.gz

종류를 알 수 없는 바이너리

foobar-1.2.3.bin.ELF.tar.gz

ELF 바이너리

foobar-1.2.3.bin.ELF.static.tar.gz

ELF 정적 링크된 바이너리

foobar-1.2.3.bin.SPARC.tar.gz

SPARC 바이너리

제발 `foobar-ELF-1.2.3.tar.gz'와 같이 사용하지 마라. 왜냐하면 프로그램은 접두사에 삽입된 종류를 나타내는 부분(`-ELF'와 같은)을 이해하기 못하기 때문이다.

일반적으로 바람직한 이름의 형태는 다음과 같은 순서로 되어 있다:

  1. 프로젝트 접두사
  2. 이음선(dash)
  3. 버전 번호
  4. 마침표(dot)
  5. "src" 또는 "bin" (선택사항)
  6. 마침표(dot) 또는 이음선(dash) (마침표를 선호함)
  7. 바이너리 종류와 옵션들 (선택사항)
  8. 압축 확장자

2.2 입력하기 쉽고 고유한 이름의 접두사를 고르는데 신중하라

접두사는 모든 프로젝트 파일들에게 공유되어야 하고 읽고 입력하고 기억 하기 쉬워야 한다. 그러므로 밑줄(underscore)은 사용하지 마라. 그리고 아주 특별한 이유가 없다면 대문자로 시작하거나 가운데에 대문자를 사용하지마라. -- 이러한 것들은 눈으로 자연스럽게 읽는 것을 방해하고, 바보가 영리해 보이려는 것처럼 보인다.

접두사가 고유한 것이 아니라면 그것과 같은 이름의 접두사를 가진 프로젝트를 운영하는 사람들을 혼란스럽게 만들 것이다. 그래서 맨 처음 발표하기 전에 이름이 중복되는지 확인해 보라. 확인하기 좋은 곳은 index file of Sunsite이다.


다음 이전 차례