Fossil SCM

Improvements to comments in the introduction to the files_of_checkin virtual table.

drh 2016-05-18 02:28 trunk

Commit 06e2327c90fe7e7c60817bb67eb45efcd29bc284

Parent f9decff05e419d2…

1 file changed +6 -7

M src/foci.c

+6 -7

		--- src/foci.c
		+++ src/foci.c
		@@ -13,23 +13,22 @@
13	13	** [email protected]
14	14	** http://www.hwaci.com/drh/
15	15	**
16	16	*******************************************************************************
17	17	**
18		-** This routine implements an SQLite virtual table that gives all of the
19		-** files associated with a single check-in.
	18	+** This routine implements eponymous virtual table for SQLite that gives
	19	+** all of the files associated with a single check-in.
20	20	**
21		-** The filename "foci" is short for "Files of Check-in".
	21	+** The source code filename "foci" is short for "Files of Check-in".
22	22	**
23	23	** Usage example:
24	24	**
25		-** CREATE VIRTUAL TABLE temp.foci USING files_of_checkin;
26		-** -- ^^^^--- important!
27		-** SELECT * FROM foci WHERE checkinID=symbolic_name_to_rid('trunk');
	25	+** SELECT * FROM files_of_checkin
	26	+** WHERE checkinID=symbolic_name_to_rid('trunk');
28	27	**
29	28	** The symbolic_name_to_rid('trunk') function finds the BLOB.RID value
30		-** corresponding to the 'trunk' tag. Then the files_of_checkin virtual table
	29	+** corresponding to the 'trunk' tag. Then the foci virtual table
31	30	** decodes the manifest defined by that BLOB and returns all files described
32	31	** by that manifest. The "schema" for the temp.foci table is:
33	32	**
34	33	** CREATE TABLE files_of_checkin(
35	34	** checkinID INTEGER, -- RID for the check-in manifest
36	35

	--- src/foci.c
	+++ src/foci.c
	@@ -13,23 +13,22 @@
13	** [email protected]
14	** http://www.hwaci.com/drh/
15	**
16	*******************************************************************************
17	**
18	** This routine implements an SQLite virtual table that gives all of the
19	** files associated with a single check-in.
20	**
21	** The filename "foci" is short for "Files of Check-in".
22	**
23	** Usage example:
24	**
25	** CREATE VIRTUAL TABLE temp.foci USING files_of_checkin;
26	** -- ^^^^--- important!
27	** SELECT * FROM foci WHERE checkinID=symbolic_name_to_rid('trunk');
28	**
29	** The symbolic_name_to_rid('trunk') function finds the BLOB.RID value
30	** corresponding to the 'trunk' tag. Then the files_of_checkin virtual table
31	** decodes the manifest defined by that BLOB and returns all files described
32	** by that manifest. The "schema" for the temp.foci table is:
33	**
34	** CREATE TABLE files_of_checkin(
35	** checkinID INTEGER, -- RID for the check-in manifest
36

	--- src/foci.c
	+++ src/foci.c
	@@ -13,23 +13,22 @@
13	** [email protected]
14	** http://www.hwaci.com/drh/
15	**
16	*******************************************************************************
17	**
18	** This routine implements eponymous virtual table for SQLite that gives
19	** all of the files associated with a single check-in.
20	**
21	** The source code filename "foci" is short for "Files of Check-in".
22	**
23	** Usage example:
24	**
25	** SELECT * FROM files_of_checkin
26	** WHERE checkinID=symbolic_name_to_rid('trunk');

27	**
28	** The symbolic_name_to_rid('trunk') function finds the BLOB.RID value
29	** corresponding to the 'trunk' tag. Then the foci virtual table
30	** decodes the manifest defined by that BLOB and returns all files described
31	** by that manifest. The "schema" for the temp.foci table is:
32	**
33	** CREATE TABLE files_of_checkin(
34	** checkinID INTEGER, -- RID for the check-in manifest
35