Bill Kim 김빌

Contribution · PostgreSQL · core docs

config.sgml id / xreflabel 정합성 — doc-only

doc/src/sgml/config.sgml의 두 군데 varlistentry attribute가 같은 파일의 다른 모든 항목과 어긋나 있어서 정합성을 맞춤. behaviour 변경 없음, on-disk 영향 없음, callsite churn 없음. git diff --stat: 1 file, +2/-2.

pgsql-hackersheld for moderation

1. 발견

btree_gist NaN 패치 작업 중 doc/src/sgml/config.sgml를 훑다가 두 군데 attribute 형식이 같은 파일의 다른 항목들과 어긋나 있는 게 보임. 둘 다 incoming linkend 참조가 없어서 docs 빌드는 통과하지만, 정합성이 깨져 있는 상태.

2. 수정

(a) enable_group_by_reordering id 단어 경계

BEFORE: 

<varlistentry id="guc-enable-groupby-reordering" xreflabel="enable_group_by_reordering">
  <term><varname>enable_group_by_reordering</varname> (<type>boolean</type>)

AFTER: 

<varlistentry id="guc-enable-group-by-reordering" xreflabel="enable_group_by_reordering">
  <term><varname>enable_group_by_reordering</varname> (<type>boolean</type>)

같은 파일의 다른 enable_* 파라미터는 모두 GUC 이름의 underscore 자리를 hyphen으로 바꾸는 guc-enable-X-y-z 형식 — guc-enable-parallel-append (enable_parallel_append), guc-enable-partition-pruning (enable_partition_pruning) 등. enable_group_by_reordering만 group_by가 groupby로 붙어 있었음.

(b) quote_all_identifiers xreflabel 형식

BEFORE: 

<varlistentry id="guc-quote-all-identifiers" xreflabel="quote-all-identifiers">
  <term><varname>quote_all_identifiers</varname> (<type>boolean</type>)

AFTER: 

<varlistentry id="guc-quote-all-identifiers" xreflabel="quote_all_identifiers">
  <term><varname>quote_all_identifiers</varname> (<type>boolean</type>)

같은 파일의 다른 모든 xreflabel은 GUC 이름 그대로 underscore 형식 (xreflabel="archive_command", xreflabel="autovacuum_freeze_max_age" 등). quote_all_identifiers 항목만 hyphen 형식이었음.

3. 영향 범위

  • grep -rn 'linkend="guc-enable-groupby-reordering"' doc/ src/ → 0 hit (broken id로 들어오는 참조 없음)
  • grep -rn 'linkend="guc-enable-group-by-reordering"' doc/ src/ → 0 hit (corrected id로 들어오는 참조도 없음)
  • grep -rn 'linkend="guc-quote-all-identifiers"' doc/ src/ → 0 hit

따라서 외부 cross-reference가 깨지거나 새로 생기는 케이스 없음. 순수 attribute 값 정합성만 맞추는 변경.

4. 빌드 확인

docs 빌드는 SGML attribute 값 자체에 대해 lint하지 않음(id와 xreflabel는 모두 free-form string으로 인정됨). 따라서 변경 전후 모두 docs 빌드 통과. xmllint --noout doc/src/sgml/config.sgml 도 entity warning 외 syntax error 없음 (변경 전후 동일).

제출 현황

관련 자료