Fossil SCM
Trivial doc updates to www/json-api/...
Commit
73373b9d21300154efbca544d8662c53bd45a8662b55ce98d620896ff07ac381
Parent
d355faf80cf68ca…
2 files changed
+2
-2
+4
-4
+2
-2
| --- www/json-api/conventions.md | ||
| +++ www/json-api/conventions.md | ||
| @@ -181,12 +181,12 @@ | ||
| 181 | 181 | but few, if any, use negative values). |
| 182 | 182 | |
| 183 | 183 | **Boolean** parameters are a bit schizophrenic... |
| 184 | 184 | |
| 185 | 185 | In **CLI mode**, boolean flags do not have a value, per se, and thus |
| 186 | -require no string-to-bool conversion. e.g. `fossil foo -aBoolOpt | |
| 187 | --non-bool-opt value`. | |
| 186 | +require no string-to-bool conversion. e.g. | |
| 187 | +`fossil foo -aBoolOpt -non-bool-opt value`. | |
| 188 | 188 | |
| 189 | 189 | Those which arrive as strings via **GET parameters** treat any of the |
| 190 | 190 | following as true: a string starting with a character in the set |
| 191 | 191 | `[1-9tT]`. All other string values are considered to be false for this |
| 192 | 192 | purpose. |
| 193 | 193 |
| --- www/json-api/conventions.md | |
| +++ www/json-api/conventions.md | |
| @@ -181,12 +181,12 @@ | |
| 181 | but few, if any, use negative values). |
| 182 | |
| 183 | **Boolean** parameters are a bit schizophrenic... |
| 184 | |
| 185 | In **CLI mode**, boolean flags do not have a value, per se, and thus |
| 186 | require no string-to-bool conversion. e.g. `fossil foo -aBoolOpt |
| 187 | -non-bool-opt value`. |
| 188 | |
| 189 | Those which arrive as strings via **GET parameters** treat any of the |
| 190 | following as true: a string starting with a character in the set |
| 191 | `[1-9tT]`. All other string values are considered to be false for this |
| 192 | purpose. |
| 193 |
| --- www/json-api/conventions.md | |
| +++ www/json-api/conventions.md | |
| @@ -181,12 +181,12 @@ | |
| 181 | but few, if any, use negative values). |
| 182 | |
| 183 | **Boolean** parameters are a bit schizophrenic... |
| 184 | |
| 185 | In **CLI mode**, boolean flags do not have a value, per se, and thus |
| 186 | require no string-to-bool conversion. e.g. |
| 187 | `fossil foo -aBoolOpt -non-bool-opt value`. |
| 188 | |
| 189 | Those which arrive as strings via **GET parameters** treat any of the |
| 190 | following as true: a string starting with a character in the set |
| 191 | `[1-9tT]`. All other string values are considered to be false for this |
| 192 | purpose. |
| 193 |
+4
-4
| --- www/json-api/hacking.md | ||
| +++ www/json-api/hacking.md | ||
| @@ -38,11 +38,11 @@ | ||
| 38 | 38 | |
| 39 | 39 | <a id="json-c-api"></a> |
| 40 | 40 | # JSON C API |
| 41 | 41 | |
| 42 | 42 | libcson, the underlying JSON API, is a separate project, included in |
| 43 | -fossil in "amalgamation" form: see `src/cson_amalgamation.[ch]`. It has | |
| 43 | +fossil in "amalgamation" form: see `extsrc/cson_amalgamation.[ch]`. It has | |
| 44 | 44 | thorough API docs and a good deal of information is in its wiki: |
| 45 | 45 | |
| 46 | 46 | [](https://fossil.wanderinghorse.net/wikis/cson/) |
| 47 | 47 | |
| 48 | 48 | In particular: |
| @@ -51,12 +51,12 @@ | ||
| 51 | 51 | |
| 52 | 52 | gives an overview of its architecture. Occasionally new versions of it |
| 53 | 53 | are pulled into the Fossil tree, but other developers generally need not |
| 54 | 54 | concern themselves with that. |
| 55 | 55 | |
| 56 | -(Trivia: the cson wiki's back-end is fossil, living on top of a | |
| 57 | -JavaScript+HTML5 application.) | |
| 56 | +(Trivia: the cson wiki's back-end is fossil using this very JSON API, | |
| 57 | +living on top of a custom JavaScript+HTML5 application.) | |
| 58 | 58 | |
| 59 | 59 | Only a small handful of low-level fossil routines actually input or |
| 60 | 60 | output JSON text (only for reading in POST data and sending the |
| 61 | 61 | response). In the C code we work with the higher-level JSON value |
| 62 | 62 | abstractions provided by cson (conceptually similar to an XML DOM). All |
| @@ -309,11 +309,11 @@ | ||
| 309 | 309 | The `cson_sqlite3_xxx()` family of functions convert `sqlite3_stmt` rows |
| 310 | 310 | to Arrays or Objects, or convert single columns to a JSON-compatible |
| 311 | 311 | form. See `json_stmt_to_array_of_obj()`, |
| 312 | 312 | `json_stmt_to_array_of_array()` (both in `src/json.c`), and |
| 313 | 313 | `cson_sqlite3_column_to_value()` and friends (in |
| 314 | -`src/cson_amalgamation.h`). They work in an intuitive way for numeric | |
| 314 | +`extsrc/cson_amalgamation.h`). They work in an intuitive way for numeric | |
| 315 | 315 | types, but they optimistically/natively *assume* that any fields of type |
| 316 | 316 | TEXT or BLOB are actually UTF8 data, and treat them as such. cson's |
| 317 | 317 | string class only handles UTF8 data and it is semantically illegal to |
| 318 | 318 | feed them anything but UTF8. Violating this will likely result in |
| 319 | 319 | down-stream errors (e.g. when emiting the JSON string output). **The |
| 320 | 320 |
| --- www/json-api/hacking.md | |
| +++ www/json-api/hacking.md | |
| @@ -38,11 +38,11 @@ | |
| 38 | |
| 39 | <a id="json-c-api"></a> |
| 40 | # JSON C API |
| 41 | |
| 42 | libcson, the underlying JSON API, is a separate project, included in |
| 43 | fossil in "amalgamation" form: see `src/cson_amalgamation.[ch]`. It has |
| 44 | thorough API docs and a good deal of information is in its wiki: |
| 45 | |
| 46 | [](https://fossil.wanderinghorse.net/wikis/cson/) |
| 47 | |
| 48 | In particular: |
| @@ -51,12 +51,12 @@ | |
| 51 | |
| 52 | gives an overview of its architecture. Occasionally new versions of it |
| 53 | are pulled into the Fossil tree, but other developers generally need not |
| 54 | concern themselves with that. |
| 55 | |
| 56 | (Trivia: the cson wiki's back-end is fossil, living on top of a |
| 57 | JavaScript+HTML5 application.) |
| 58 | |
| 59 | Only a small handful of low-level fossil routines actually input or |
| 60 | output JSON text (only for reading in POST data and sending the |
| 61 | response). In the C code we work with the higher-level JSON value |
| 62 | abstractions provided by cson (conceptually similar to an XML DOM). All |
| @@ -309,11 +309,11 @@ | |
| 309 | The `cson_sqlite3_xxx()` family of functions convert `sqlite3_stmt` rows |
| 310 | to Arrays or Objects, or convert single columns to a JSON-compatible |
| 311 | form. See `json_stmt_to_array_of_obj()`, |
| 312 | `json_stmt_to_array_of_array()` (both in `src/json.c`), and |
| 313 | `cson_sqlite3_column_to_value()` and friends (in |
| 314 | `src/cson_amalgamation.h`). They work in an intuitive way for numeric |
| 315 | types, but they optimistically/natively *assume* that any fields of type |
| 316 | TEXT or BLOB are actually UTF8 data, and treat them as such. cson's |
| 317 | string class only handles UTF8 data and it is semantically illegal to |
| 318 | feed them anything but UTF8. Violating this will likely result in |
| 319 | down-stream errors (e.g. when emiting the JSON string output). **The |
| 320 |
| --- www/json-api/hacking.md | |
| +++ www/json-api/hacking.md | |
| @@ -38,11 +38,11 @@ | |
| 38 | |
| 39 | <a id="json-c-api"></a> |
| 40 | # JSON C API |
| 41 | |
| 42 | libcson, the underlying JSON API, is a separate project, included in |
| 43 | fossil in "amalgamation" form: see `extsrc/cson_amalgamation.[ch]`. It has |
| 44 | thorough API docs and a good deal of information is in its wiki: |
| 45 | |
| 46 | [](https://fossil.wanderinghorse.net/wikis/cson/) |
| 47 | |
| 48 | In particular: |
| @@ -51,12 +51,12 @@ | |
| 51 | |
| 52 | gives an overview of its architecture. Occasionally new versions of it |
| 53 | are pulled into the Fossil tree, but other developers generally need not |
| 54 | concern themselves with that. |
| 55 | |
| 56 | (Trivia: the cson wiki's back-end is fossil using this very JSON API, |
| 57 | living on top of a custom JavaScript+HTML5 application.) |
| 58 | |
| 59 | Only a small handful of low-level fossil routines actually input or |
| 60 | output JSON text (only for reading in POST data and sending the |
| 61 | response). In the C code we work with the higher-level JSON value |
| 62 | abstractions provided by cson (conceptually similar to an XML DOM). All |
| @@ -309,11 +309,11 @@ | |
| 309 | The `cson_sqlite3_xxx()` family of functions convert `sqlite3_stmt` rows |
| 310 | to Arrays or Objects, or convert single columns to a JSON-compatible |
| 311 | form. See `json_stmt_to_array_of_obj()`, |
| 312 | `json_stmt_to_array_of_array()` (both in `src/json.c`), and |
| 313 | `cson_sqlite3_column_to_value()` and friends (in |
| 314 | `extsrc/cson_amalgamation.h`). They work in an intuitive way for numeric |
| 315 | types, but they optimistically/natively *assume* that any fields of type |
| 316 | TEXT or BLOB are actually UTF8 data, and treat them as such. cson's |
| 317 | string class only handles UTF8 data and it is semantically illegal to |
| 318 | feed them anything but UTF8. Violating this will likely result in |
| 319 | down-stream errors (e.g. when emiting the JSON string output). **The |
| 320 |