Fossil SCM

Improvements to the /timeline documentation.

drh 2016-05-30 00:42 trunk
Commit e448abd0eaff223f39ea4c15b39bc2fc57322ce1
2 files changed +7 -2 +14 -17
+7 -2
--- src/main.c
+++ src/main.c
@@ -1283,13 +1283,18 @@
12831283
if( zCmd==0 ) zCmd = P("name");
12841284
style_header("Command-line Help");
12851285
if( zCmd ){
12861286
int rc, idx;
12871287
char *z, *s, *d;
1288
- const char *zCmdOrPage = ('/'==*zCmd) ? "page" : "command";
12891288
style_submenu_element("Command-List", "Command-List", "%s/help", g.zTop);
1290
- @ <h1>The "%s(zCmd)" %s(zCmdOrPage):</h1>
1289
+ if( *zCmd=='/' ){
1290
+ /* Some of the webpages require query parameters in order to work.
1291
+ ** @ <h1>The "<a href='%R%s(zCmd)'>%s(zCmd)</a>" page:</h1> */
1292
+ @ <h1>The "%s(zCmd)" page:</h1>
1293
+ }else{
1294
+ @ <h1>The "%s(zCmd)" command:</h1>
1295
+ }
12911296
rc = name_search(zCmd, aCommand, count(aCommand), 0, &idx);
12921297
if( rc==1 ){
12931298
@ unknown command: %s(zCmd)
12941299
}else if( rc==2 ){
12951300
@ ambiguous command prefix: %s(zCmd)
12961301
--- src/main.c
+++ src/main.c
@@ -1283,13 +1283,18 @@
1283 if( zCmd==0 ) zCmd = P("name");
1284 style_header("Command-line Help");
1285 if( zCmd ){
1286 int rc, idx;
1287 char *z, *s, *d;
1288 const char *zCmdOrPage = ('/'==*zCmd) ? "page" : "command";
1289 style_submenu_element("Command-List", "Command-List", "%s/help", g.zTop);
1290 @ <h1>The "%s(zCmd)" %s(zCmdOrPage):</h1>
 
 
 
 
 
 
1291 rc = name_search(zCmd, aCommand, count(aCommand), 0, &idx);
1292 if( rc==1 ){
1293 @ unknown command: %s(zCmd)
1294 }else if( rc==2 ){
1295 @ ambiguous command prefix: %s(zCmd)
1296
--- src/main.c
+++ src/main.c
@@ -1283,13 +1283,18 @@
1283 if( zCmd==0 ) zCmd = P("name");
1284 style_header("Command-line Help");
1285 if( zCmd ){
1286 int rc, idx;
1287 char *z, *s, *d;
 
1288 style_submenu_element("Command-List", "Command-List", "%s/help", g.zTop);
1289 if( *zCmd=='/' ){
1290 /* Some of the webpages require query parameters in order to work.
1291 ** @ <h1>The "<a href='%R%s(zCmd)'>%s(zCmd)</a>" page:</h1> */
1292 @ <h1>The "%s(zCmd)" page:</h1>
1293 }else{
1294 @ <h1>The "%s(zCmd)" command:</h1>
1295 }
1296 rc = name_search(zCmd, aCommand, count(aCommand), 0, &idx);
1297 if( rc==1 ){
1298 @ unknown command: %s(zCmd)
1299 }else if( rc==2 ){
1300 @ ambiguous command prefix: %s(zCmd)
1301
+14 -17
--- src/timeline.c
+++ src/timeline.c
@@ -1193,43 +1193,40 @@
11931193
**
11941194
** a=TIMEORTAG after this event
11951195
** b=TIMEORTAG before this event
11961196
** c=TIMEORTAG "circa" this event
11971197
** m=TIMEORTAG mark this event
1198
-** n=COUNT max number of events in output
1199
-** p=UUID artifact and up to COUNT parents and ancestors
1200
-** d=UUID artifact and up to COUNT descendants
1201
-** dp=UUID The same as d=UUID&p=UUID
1202
-** t=TAGID show only check-ins with the given tagid
1203
-** r=TAGID show check-ins related to tagid
1204
-** u=USER only if belonging to this user
1198
+** n=COUNT suggested number of events in output
1199
+** p=CHECKIN parents and ancestors of CHECKIN
1200
+** d=CHECKIN descendants of CHECIN
1201
+** dp=CHECKIN The same as d=CHECKIN&p=CHECKIN
1202
+** t=TAG show only check-ins with the given TAG
1203
+** r=TAG show check-ins related to TAG
1204
+** u=USER only show items associated with USER
12051205
** y=TYPE 'ci', 'w', 't', 'e', or (default) 'all'
1206
-** s=TEXT string search (comment and brief)
1207
-** ng Suppress the graph if present
1208
-** nd Suppress "divider" lines
1206
+** ng No Graph.
1207
+** nd Do not highlight the focus check-in
12091208
** v Show details of files changed
1210
-** f=UUID Show family (immediate parents and children) of UUID
1211
-** from=UUID Path from...
1212
-** to=UUID ... to this
1209
+** f=CHECKIN Show family (immediate parents and children) of CHECKIN
1210
+** from=CHECKIN Path from...
1211
+** to=CHECKIN ... to this
12131212
** shortest ... show only the shortest path
1214
-** uf=FUUID Show only check-ins that use given file version
1213
+** uf=FILE_SHA1 Show only check-ins that contain the given file version
12151214
** brbg Background color from branch name
12161215
** ubg Background color from user
12171216
** namechng Show only check-ins that have filename changes
12181217
** forks Show only forks and their children
12191218
** ym=YYYY-MM Show only events for the given year/month.
1219
+** yw=YYYY-WW Show only events for the given week of the given year
12201220
** ymd=YYYY-MM-DD Show only events on the given day
12211221
** datefmt=N Override the date format
12221222
** bisect Show the check-ins that are in the current bisect
12231223
**
12241224
** p= and d= can appear individually or together. If either p= or d=
12251225
** appear, then u=, y=, a=, and b= are ignored.
12261226
**
12271227
** If both a= and b= appear then both upper and lower bounds are honored.
1228
-**
1229
-** If n= is missing, the default count is 50 for most queries but
1230
-** drops to 11 for c= queries.
12311228
*/
12321229
void page_timeline(void){
12331230
Stmt q; /* Query used to generate the timeline */
12341231
Blob sql; /* text of SQL used to generate timeline */
12351232
Blob desc; /* Description of the timeline */
12361233
--- src/timeline.c
+++ src/timeline.c
@@ -1193,43 +1193,40 @@
1193 **
1194 ** a=TIMEORTAG after this event
1195 ** b=TIMEORTAG before this event
1196 ** c=TIMEORTAG "circa" this event
1197 ** m=TIMEORTAG mark this event
1198 ** n=COUNT max number of events in output
1199 ** p=UUID artifact and up to COUNT parents and ancestors
1200 ** d=UUID artifact and up to COUNT descendants
1201 ** dp=UUID The same as d=UUID&p=UUID
1202 ** t=TAGID show only check-ins with the given tagid
1203 ** r=TAGID show check-ins related to tagid
1204 ** u=USER only if belonging to this user
1205 ** y=TYPE 'ci', 'w', 't', 'e', or (default) 'all'
1206 ** s=TEXT string search (comment and brief)
1207 ** ng Suppress the graph if present
1208 ** nd Suppress "divider" lines
1209 ** v Show details of files changed
1210 ** f=UUID Show family (immediate parents and children) of UUID
1211 ** from=UUID Path from...
1212 ** to=UUID ... to this
1213 ** shortest ... show only the shortest path
1214 ** uf=FUUID Show only check-ins that use given file version
1215 ** brbg Background color from branch name
1216 ** ubg Background color from user
1217 ** namechng Show only check-ins that have filename changes
1218 ** forks Show only forks and their children
1219 ** ym=YYYY-MM Show only events for the given year/month.
 
1220 ** ymd=YYYY-MM-DD Show only events on the given day
1221 ** datefmt=N Override the date format
1222 ** bisect Show the check-ins that are in the current bisect
1223 **
1224 ** p= and d= can appear individually or together. If either p= or d=
1225 ** appear, then u=, y=, a=, and b= are ignored.
1226 **
1227 ** If both a= and b= appear then both upper and lower bounds are honored.
1228 **
1229 ** If n= is missing, the default count is 50 for most queries but
1230 ** drops to 11 for c= queries.
1231 */
1232 void page_timeline(void){
1233 Stmt q; /* Query used to generate the timeline */
1234 Blob sql; /* text of SQL used to generate timeline */
1235 Blob desc; /* Description of the timeline */
1236
--- src/timeline.c
+++ src/timeline.c
@@ -1193,43 +1193,40 @@
1193 **
1194 ** a=TIMEORTAG after this event
1195 ** b=TIMEORTAG before this event
1196 ** c=TIMEORTAG "circa" this event
1197 ** m=TIMEORTAG mark this event
1198 ** n=COUNT suggested number of events in output
1199 ** p=CHECKIN parents and ancestors of CHECKIN
1200 ** d=CHECKIN descendants of CHECIN
1201 ** dp=CHECKIN The same as d=CHECKIN&p=CHECKIN
1202 ** t=TAG show only check-ins with the given TAG
1203 ** r=TAG show check-ins related to TAG
1204 ** u=USER only show items associated with USER
1205 ** y=TYPE 'ci', 'w', 't', 'e', or (default) 'all'
1206 ** ng No Graph.
1207 ** nd Do not highlight the focus check-in
 
1208 ** v Show details of files changed
1209 ** f=CHECKIN Show family (immediate parents and children) of CHECKIN
1210 ** from=CHECKIN Path from...
1211 ** to=CHECKIN ... to this
1212 ** shortest ... show only the shortest path
1213 ** uf=FILE_SHA1 Show only check-ins that contain the given file version
1214 ** brbg Background color from branch name
1215 ** ubg Background color from user
1216 ** namechng Show only check-ins that have filename changes
1217 ** forks Show only forks and their children
1218 ** ym=YYYY-MM Show only events for the given year/month.
1219 ** yw=YYYY-WW Show only events for the given week of the given year
1220 ** ymd=YYYY-MM-DD Show only events on the given day
1221 ** datefmt=N Override the date format
1222 ** bisect Show the check-ins that are in the current bisect
1223 **
1224 ** p= and d= can appear individually or together. If either p= or d=
1225 ** appear, then u=, y=, a=, and b= are ignored.
1226 **
1227 ** If both a= and b= appear then both upper and lower bounds are honored.
 
 
 
1228 */
1229 void page_timeline(void){
1230 Stmt q; /* Query used to generate the timeline */
1231 Blob sql; /* text of SQL used to generate timeline */
1232 Blob desc; /* Description of the timeline */
1233

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button