Fossil SCM

Update and improve comments.

mistachkin 2015-08-21 04:33 UTC ckol-th1-dir-cmd
Commit 676d97d70cdcf833e9364076aa0bc7dfaae59071
1 file changed +6 -4
+6 -4
--- src/doc.c
+++ src/doc.c
@@ -522,14 +522,16 @@
522522
** for looking at what a file will look like using the /doc webpage after
523523
** it gets checked in.
524524
**
525525
** The file extension is used to decide how to render the file.
526526
**
527
-** If FILE ends in "/" then names "FILE/index.html", "FILE/index.wiki",
528
-** and "FILE/index.md" are tried in that order. If none of those are found,
529
-** then FILE is completely replaced by "404.md" and tried. If that is
530
-** not found, then a default 404 screen is generated.
527
+** If FILE ends in "/" then the names "FILE/index.html", "FILE/index.wiki",
528
+** and "FILE/index.md" are tried in that order. If the binary was compiled
529
+** with TH1 embedded documentation support and the "th1-docs" setting is
530
+** enabled, the name "FILE/index.th1" is also tried. If none of those are
531
+** found, then FILE is completely replaced by "404.md" and tried. If that
532
+** is not found, then a default 404 screen is generated.
531533
*/
532534
void doc_page(void){
533535
const char *zName; /* Argument to the /doc page */
534536
const char *zOrigName = "?"; /* Original document name */
535537
const char *zMime; /* Document MIME type */
536538
--- src/doc.c
+++ src/doc.c
@@ -522,14 +522,16 @@
522 ** for looking at what a file will look like using the /doc webpage after
523 ** it gets checked in.
524 **
525 ** The file extension is used to decide how to render the file.
526 **
527 ** If FILE ends in "/" then names "FILE/index.html", "FILE/index.wiki",
528 ** and "FILE/index.md" are tried in that order. If none of those are found,
529 ** then FILE is completely replaced by "404.md" and tried. If that is
530 ** not found, then a default 404 screen is generated.
 
 
531 */
532 void doc_page(void){
533 const char *zName; /* Argument to the /doc page */
534 const char *zOrigName = "?"; /* Original document name */
535 const char *zMime; /* Document MIME type */
536
--- src/doc.c
+++ src/doc.c
@@ -522,14 +522,16 @@
522 ** for looking at what a file will look like using the /doc webpage after
523 ** it gets checked in.
524 **
525 ** The file extension is used to decide how to render the file.
526 **
527 ** If FILE ends in "/" then the names "FILE/index.html", "FILE/index.wiki",
528 ** and "FILE/index.md" are tried in that order. If the binary was compiled
529 ** with TH1 embedded documentation support and the "th1-docs" setting is
530 ** enabled, the name "FILE/index.th1" is also tried. If none of those are
531 ** found, then FILE is completely replaced by "404.md" and tried. If that
532 ** is not found, then a default 404 screen is generated.
533 */
534 void doc_page(void){
535 const char *zName; /* Argument to the /doc page */
536 const char *zOrigName = "?"; /* Original document name */
537 const char *zMime; /* Document MIME type */
538

Keyboard Shortcuts

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