From bba7535c7a5c0db92bc8d4409a3ce13eab0f4d1c Mon Sep 17 00:00:00 2001 From: "Chao Li (Evan)" Date: Thu, 25 Dec 2025 09:50:20 +0800 Subject: [PATCH v1] Docs: make documentation source file references consistent MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The documentation currently mixes bare filenames and full source-tree paths when referring to PostgreSQL source files and headers. Update these references to consistently use full paths within the source tree (e.g., src/include/…, src/backend/…). Author: Chao Li --- doc/src/sgml/config.sgml | 6 +++--- doc/src/sgml/cube.sgml | 2 +- doc/src/sgml/ecpg.sgml | 6 +++--- doc/src/sgml/fdwhandler.sgml | 12 ++++++------ doc/src/sgml/generic-wal.sgml | 4 ++-- doc/src/sgml/gin.sgml | 2 +- doc/src/sgml/indexam.sgml | 2 +- doc/src/sgml/indices.sgml | 2 +- doc/src/sgml/libpq.sgml | 2 +- doc/src/sgml/pgbuffercache.sgml | 2 +- doc/src/sgml/pgoverexplain.sgml | 6 +++--- doc/src/sgml/pgwalinspect.sgml | 2 +- doc/src/sgml/spi.sgml | 4 ++-- doc/src/sgml/storage.sgml | 2 +- doc/src/sgml/trigger.sgml | 6 +++--- doc/src/sgml/wal.sgml | 2 +- doc/src/sgml/xaggr.sgml | 2 +- doc/src/sgml/xfunc.sgml | 2 +- 18 files changed, 33 insertions(+), 33 deletions(-) diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index cdfe8e376f0..fd6b3b49674 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -12310,8 +12310,8 @@ dynamic_library_path = '/usr/local/lib/postgresql:$libdir' This parameter can be very helpful when trying to trigger hard-to-reproduce bugs involving concurrent catalog changes, but it is otherwise rarely needed. See the source code files - inval.c and - pg_config_manual.h for details. + src/backend/utils/cache/inval.c and + src/include/pg_config_manual.h for details. @@ -12437,7 +12437,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:$libdir' Enabling this forces all parse and plan trees to be passed through - outfuncs.c/readfuncs.c, to + src/backend/nodes/outfuncs.c and src/backend/nodes/readfuncs.c, to facilitate catching errors and omissions in those modules. The default is off. diff --git a/doc/src/sgml/cube.sgml b/doc/src/sgml/cube.sgml index a11c0cbd767..67d320c1500 100644 --- a/doc/src/sgml/cube.sgml +++ b/doc/src/sgml/cube.sgml @@ -597,7 +597,7 @@ t To make it harder for people to break things, there is a limit of 100 on the number of dimensions of cubes. This is set - in cubedata.h if you need something bigger. + in contrib/cube/cubedata.h if you need something bigger. diff --git a/doc/src/sgml/ecpg.sgml b/doc/src/sgml/ecpg.sgml index 734a2df69e8..23d9f7f3c33 100644 --- a/doc/src/sgml/ecpg.sgml +++ b/doc/src/sgml/ecpg.sgml @@ -4198,7 +4198,7 @@ typedef struct sqlvar_struct sqlvar_t; Contains the type identifier of the field. For values, - see enum ECPGttype in ecpgtype.h. + see enum ECPGttype in src/interfaces/ecpg/include/ecpgtype.h. @@ -8599,8 +8599,8 @@ EXEC SQL INCLUDE sqlda.h; free(sqlda); /* The main structure is all to be free(), * sqlda and sqlda->sqlvar is in one allocated area */ - For more information, see the sqlda.h header and the - src/interfaces/ecpg/test/compat_informix/sqlda.pgc regression test. + For more information, see the src/interfaces/ecpg/include/sqlda.h header and the + src/interfaces/ecpg/test/compat_informix/sqlda.pgc regression test. diff --git a/doc/src/sgml/fdwhandler.sgml b/doc/src/sgml/fdwhandler.sgml index c6d66414b8e..0f8bd9c395a 100644 --- a/doc/src/sgml/fdwhandler.sgml +++ b/doc/src/sgml/fdwhandler.sgml @@ -1708,7 +1708,7 @@ GetForeignDataWrapperExtended(Oid fdwid, bits16 flags); This function returns a ForeignDataWrapper object for the foreign-data wrapper with the given OID. A ForeignDataWrapper object contains properties - of the FDW (see foreign/foreign.h for details). + of the FDW (see src/include/foreign/foreign.h for details). flags is a bitwise-or'd bit mask indicating an extra set of options. It can take the value FDW_MISSING_OK, in which case a NULL @@ -1725,7 +1725,7 @@ GetForeignDataWrapper(Oid fdwid); This function returns a ForeignDataWrapper object for the foreign-data wrapper with the given OID. A ForeignDataWrapper object contains properties - of the FDW (see foreign/foreign.h for details). + of the FDW (see src/include/foreign/foreign.h for details). @@ -1737,7 +1737,7 @@ GetForeignServerExtended(Oid serverid, bits16 flags); This function returns a ForeignServer object for the foreign server with the given OID. A ForeignServer object contains properties - of the server (see foreign/foreign.h for details). + of the server (see src/include/foreign/foreign.h for details). flags is a bitwise-or'd bit mask indicating an extra set of options. It can take the value FSV_MISSING_OK, in which case a NULL @@ -1754,7 +1754,7 @@ GetForeignServer(Oid serverid); This function returns a ForeignServer object for the foreign server with the given OID. A ForeignServer object contains properties - of the server (see foreign/foreign.h for details). + of the server (see src/include/foreign/foreign.h for details). @@ -1768,7 +1768,7 @@ GetUserMapping(Oid userid, Oid serverid); mapping for the specific user, it will return the mapping for PUBLIC, or throw error if there is none.) A UserMapping object contains properties of the - user mapping (see foreign/foreign.h for details). + user mapping (see src/include/foreign/foreign.h for details). @@ -1780,7 +1780,7 @@ GetForeignTable(Oid relid); This function returns a ForeignTable object for the foreign table with the given OID. A ForeignTable object contains properties of the - foreign table (see foreign/foreign.h for details). + foreign table (see src/include/foreign/foreign.h for details). diff --git a/doc/src/sgml/generic-wal.sgml b/doc/src/sgml/generic-wal.sgml index 41f97ad7dc8..115aa77ff7e 100644 --- a/doc/src/sgml/generic-wal.sgml +++ b/doc/src/sgml/generic-wal.sgml @@ -19,8 +19,8 @@ The API for constructing generic WAL records is defined in - access/generic_xlog.h and implemented - in access/transam/generic_xlog.c. + src/include/access/generic_xlog.h and implemented + in src/backend/access/transam/generic_xlog.c. diff --git a/doc/src/sgml/gin.sgml b/doc/src/sgml/gin.sgml index 82410b1fbdf..c2fd5ae1a70 100644 --- a/doc/src/sgml/gin.sgml +++ b/doc/src/sgml/gin.sgml @@ -227,7 +227,7 @@ in most cases is probably not a good candidate for a GIN operator class.) The symbols to use for setting this mode are defined in - access/gin.h. + src/include/access/gin.h. diff --git a/doc/src/sgml/indexam.sgml b/doc/src/sgml/indexam.sgml index 63d7e376f19..30c103f67f2 100644 --- a/doc/src/sgml/indexam.sgml +++ b/doc/src/sgml/indexam.sgml @@ -619,7 +619,7 @@ amadjustmembers (Oid opfamilyoid, case opclassoid is InvalidOid. The List arguments are lists of OpFamilyMember structs, as defined - in amapi.h. + in src/include/access/amapi.h. Tests done by this function will typically be a subset of those performed by amvalidate, diff --git a/doc/src/sgml/indices.sgml b/doc/src/sgml/indices.sgml index 55f39b0df2f..173298dc21b 100644 --- a/doc/src/sgml/indices.sgml +++ b/doc/src/sgml/indices.sgml @@ -451,7 +451,7 @@ CREATE INDEX test2_mm_idx ON test2 (major, minor); can be added to the index. Indexes can have up to 32 columns, including INCLUDE columns. (This limit can be altered when building PostgreSQL; see the - file pg_config_manual.h.) + file src/include/pg_config_manual.h.) diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 7d05938feda..c87e170d575 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -4581,7 +4581,7 @@ Oid PQftype(const PGresult *res, You can query the system table pg_type to obtain the names and properties of the various data types. The OIDs of the built-in data types are defined - in the file catalog/pg_type_d.h + in the file src/include/catalog/pg_type_d.h in the PostgreSQL installation's include directory. diff --git a/doc/src/sgml/pgbuffercache.sgml b/doc/src/sgml/pgbuffercache.sgml index 1e9aee10275..3d680a7059b 100644 --- a/doc/src/sgml/pgbuffercache.sgml +++ b/doc/src/sgml/pgbuffercache.sgml @@ -213,7 +213,7 @@ Fork number within the relation; see - common/relpath.h + src/include/common/relpath.h diff --git a/doc/src/sgml/pgoverexplain.sgml b/doc/src/sgml/pgoverexplain.sgml index e399c1cbad5..07be5cb3843 100644 --- a/doc/src/sgml/pgoverexplain.sgml +++ b/doc/src/sgml/pgoverexplain.sgml @@ -40,7 +40,7 @@ LOAD 'pg_overexplain'; the plan tree that is not normally shown because it is not expected to be of general interest. For each individual plan node, it will display the following fields. See Plan in - nodes/plannodes.h for additional documentation of these + src/include/nodes/plannodes.h for additional documentation of these fields. @@ -83,7 +83,7 @@ LOAD 'pg_overexplain'; Once per query, the DEBUG option will display the following fields. See PlannedStmt in - nodes/plannodes.h for additional detail. + src/include/nodes/plannodes.h for additional detail. @@ -186,7 +186,7 @@ LOAD 'pg_overexplain'; For more information about range table entries, see the definition of - RangeTblEntry in nodes/parsenodes.h. + RangeTblEntry in src/include/nodes/parsenodes.h. diff --git a/doc/src/sgml/pgwalinspect.sgml b/doc/src/sgml/pgwalinspect.sgml index 79c3ead40bc..3ed84bdd771 100644 --- a/doc/src/sgml/pgwalinspect.sgml +++ b/doc/src/sgml/pgwalinspect.sgml @@ -202,7 +202,7 @@ block_fpi_data | pg_class.relfilenode respectively. The relforknumber field is the fork number within the relation for the block - reference; see common/relpath.h for + reference; see src/include/common/relpath.h for details. diff --git a/doc/src/sgml/spi.sgml b/doc/src/sgml/spi.sgml index e30d0962ae7..f76d769ead8 100644 --- a/doc/src/sgml/spi.sgml +++ b/doc/src/sgml/spi.sgml @@ -1130,7 +1130,7 @@ SPIPlanPtr SPI_prepare(const char * command, int SPIPlanPtr is declared as a pointer to an opaque struct type in - spi.h. It is unwise to try to access its contents + src/include/executor/spi.h. It is unwise to try to access its contents directly, as that makes your code much more likely to break in future revisions of PostgreSQL. @@ -1171,7 +1171,7 @@ SPIPlanPtr SPI_prepare_cursor(const char * command, int < SPI_prepare_cursor is identical to SPI_prepare, except that it also allows specification of the planner's cursor options parameter. This is a bit mask - having the values shown in nodes/parsenodes.h + having the values shown in src/include/nodes/parsenodes.h for the options field of DeclareCursorStmt. SPI_prepare always takes the cursor options as zero. diff --git a/doc/src/sgml/storage.sgml b/doc/src/sgml/storage.sgml index 02ddfda834a..b85a3f72b5d 100644 --- a/doc/src/sgml/storage.sgml +++ b/doc/src/sgml/storage.sgml @@ -394,7 +394,7 @@ The oldest and most common type is a pointer to out-of-line data stored in a TOAST table that is separate from, but associated with, the table containing the TOAST pointer datum itself. These on-disk pointer datums are created by the -TOAST management code (in access/common/toast_internals.c) +TOAST management code (in src/backend/access/common/toast_internals.c) when a tuple to be stored on disk is too large to be stored as-is. Further details appear in . Alternatively, a TOAST pointer datum can contain a pointer to diff --git a/doc/src/sgml/trigger.sgml b/doc/src/sgml/trigger.sgml index 0062f1a3fd1..f90ede3304a 100644 --- a/doc/src/sgml/trigger.sgml +++ b/doc/src/sgml/trigger.sgml @@ -549,7 +549,7 @@ CALLED_AS_TRIGGER(fcinfo) struct TriggerData is defined in - commands/trigger.h: + src/include/commands/trigger.h: typedef struct TriggerData @@ -678,7 +678,7 @@ typedef struct TriggerData A pointer to a structure describing the relation that the trigger fired for. - Look at utils/rel.h for details about + Look at src/include/utils/rel.h for details about this structure. The most interesting things are tg_relation->rd_att (descriptor of the relation tuples) and tg_relation->rd_rel->relname @@ -727,7 +727,7 @@ typedef struct TriggerData A pointer to a structure of type Trigger, - defined in utils/reltrigger.h: + defined in src/include/utils/reltrigger.h: typedef struct Trigger diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml index f3b86b26be9..fb5d12501ef 100644 --- a/doc/src/sgml/wal.sgml +++ b/doc/src/sgml/wal.sgml @@ -883,7 +883,7 @@ by altering the initdb option). Each segment is divided into pages, normally 8 kB each (this size can be changed via the configure option). The WAL record headers - are described in access/xlogrecord.h; the record + are described in src/include/access/xlogrecord.h; the record content is dependent on the type of event that is being logged. Segment files are given ever-increasing numbers as names, starting at 000000010000000000000001. The numbers do not wrap, diff --git a/doc/src/sgml/xaggr.sgml b/doc/src/sgml/xaggr.sgml index bdad8d3dc2b..fa733134adc 100644 --- a/doc/src/sgml/xaggr.sgml +++ b/doc/src/sgml/xaggr.sgml @@ -661,7 +661,7 @@ if (AggCheckCallContext(fcinfo, NULL)) for ordered-set aggregates, which can inspect the substructure of the Aggref node to find out what sort ordering they are supposed to implement. Examples can be found - in orderedsetaggs.c in the PostgreSQL + in src/backend/utils/adt/orderedsetaggs.c in the PostgreSQL source code. diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml index e9288bd6b5e..5164d678638 100644 --- a/doc/src/sgml/xfunc.sgml +++ b/doc/src/sgml/xfunc.sgml @@ -2405,7 +2405,7 @@ PG_FUNCTION_INFO_V1(funcname); These convenience functions and similar ones can be found - in fmgr.h. + in src/include/fmgr.h. The DirectFunctionCalln family expect a C function name as their first argument. There are also OidFunctionCalln which -- 2.39.5 (Apple Git-154)