Fossil SCM
Add documentation about internal data structures (specifically, the CONFIG table entries used and what they mean) on the login-group setup page.
Commit
5bb4cee5ec5a67f56abf890329a50330e35e82a5ca0ccf2526f1a4255d9e974a
Parent
4420efdf32bc455…
1 file changed
+36
+36
| --- src/setup.c | ||
| +++ src/setup.c | ||
| @@ -873,10 +873,46 @@ | ||
| 873 | 873 | @ <td>%h(db_column_text(&q,1))</td> |
| 874 | 874 | @ <td>%h(db_column_text(&q,2))</td></tr> |
| 875 | 875 | } |
| 876 | 876 | db_finalize(&q); |
| 877 | 877 | @ </tbody></table> |
| 878 | + @ <h2>Interpretation</h2> | |
| 879 | + @ <ul> | |
| 880 | + @ <li><p><b>login-group-code</b> → | |
| 881 | + @ A random code assigned to each login-group. The login-group-code is | |
| 882 | + @ a unique identifier for the login-group. | |
| 883 | + @ | |
| 884 | + @ <li><p><b>login-group-name</b> → | |
| 885 | + @ The human-readable name of the login-group. | |
| 886 | + @ | |
| 887 | + @ <li><p><b>project-code</b> → | |
| 888 | + @ A random code assigned to each project. The project-code is | |
| 889 | + @ a unique identifier for the project. Multiple repositories can share | |
| 890 | + @ the same project-code. When two or more repositories have the same | |
| 891 | + @ project code, that mean those repositories are clones of each other. | |
| 892 | + @ Repositories are only able to sync if they share the same project-code. | |
| 893 | + @ | |
| 894 | + @ <li><p><b>project-description</b> → | |
| 895 | + @ A description of project in this repository. This is a verbose form | |
| 896 | + @ of project-name. This description can be edited in the second entry | |
| 897 | + @ box on the <a href="./setup_config">Setup/Configuration page</a>. | |
| 898 | + @ | |
| 899 | + @ <li><p><b>project-name</b> → | |
| 900 | + @ The human-readable name for the project. The project-name can be | |
| 901 | + @ modified in the first entry on the | |
| 902 | + @ <a href="./setup_config">Setup/Configuration page</a>. | |
| 903 | + @ | |
| 904 | + @ <li><p><b>peer-repo-<i>CODE</i></b> → | |
| 905 | + @ <i>CODE</i> is 16-character prefix of the project-code for another | |
| 906 | + @ repository that is part of the same login-group. The value is the | |
| 907 | + @ filename for the peer repository. | |
| 908 | + @ | |
| 909 | + @ <li><p><b>peer-name-<i>CODE</i></b> → | |
| 910 | + @ <i>CODE</i> is 16-character prefix of the project-code for another | |
| 911 | + @ repository that is part of the same login-group. The value is | |
| 912 | + @ project-name value for the other repository. | |
| 913 | + @ </ul> | |
| 878 | 914 | style_table_sorter(); |
| 879 | 915 | style_finish_page(); |
| 880 | 916 | } |
| 881 | 917 | |
| 882 | 918 | /* |
| 883 | 919 |
| --- src/setup.c | |
| +++ src/setup.c | |
| @@ -873,10 +873,46 @@ | |
| 873 | @ <td>%h(db_column_text(&q,1))</td> |
| 874 | @ <td>%h(db_column_text(&q,2))</td></tr> |
| 875 | } |
| 876 | db_finalize(&q); |
| 877 | @ </tbody></table> |
| 878 | style_table_sorter(); |
| 879 | style_finish_page(); |
| 880 | } |
| 881 | |
| 882 | /* |
| 883 |
| --- src/setup.c | |
| +++ src/setup.c | |
| @@ -873,10 +873,46 @@ | |
| 873 | @ <td>%h(db_column_text(&q,1))</td> |
| 874 | @ <td>%h(db_column_text(&q,2))</td></tr> |
| 875 | } |
| 876 | db_finalize(&q); |
| 877 | @ </tbody></table> |
| 878 | @ <h2>Interpretation</h2> |
| 879 | @ <ul> |
| 880 | @ <li><p><b>login-group-code</b> → |
| 881 | @ A random code assigned to each login-group. The login-group-code is |
| 882 | @ a unique identifier for the login-group. |
| 883 | @ |
| 884 | @ <li><p><b>login-group-name</b> → |
| 885 | @ The human-readable name of the login-group. |
| 886 | @ |
| 887 | @ <li><p><b>project-code</b> → |
| 888 | @ A random code assigned to each project. The project-code is |
| 889 | @ a unique identifier for the project. Multiple repositories can share |
| 890 | @ the same project-code. When two or more repositories have the same |
| 891 | @ project code, that mean those repositories are clones of each other. |
| 892 | @ Repositories are only able to sync if they share the same project-code. |
| 893 | @ |
| 894 | @ <li><p><b>project-description</b> → |
| 895 | @ A description of project in this repository. This is a verbose form |
| 896 | @ of project-name. This description can be edited in the second entry |
| 897 | @ box on the <a href="./setup_config">Setup/Configuration page</a>. |
| 898 | @ |
| 899 | @ <li><p><b>project-name</b> → |
| 900 | @ The human-readable name for the project. The project-name can be |
| 901 | @ modified in the first entry on the |
| 902 | @ <a href="./setup_config">Setup/Configuration page</a>. |
| 903 | @ |
| 904 | @ <li><p><b>peer-repo-<i>CODE</i></b> → |
| 905 | @ <i>CODE</i> is 16-character prefix of the project-code for another |
| 906 | @ repository that is part of the same login-group. The value is the |
| 907 | @ filename for the peer repository. |
| 908 | @ |
| 909 | @ <li><p><b>peer-name-<i>CODE</i></b> → |
| 910 | @ <i>CODE</i> is 16-character prefix of the project-code for another |
| 911 | @ repository that is part of the same login-group. The value is |
| 912 | @ project-name value for the other repository. |
| 913 | @ </ul> |
| 914 | style_table_sorter(); |
| 915 | style_finish_page(); |
| 916 | } |
| 917 | |
| 918 | /* |
| 919 |