Fossil SCM

Improve help text of login-group command. Mention about the -R|--repository option and format subcommand description to follow a bit more the conventions of other commands.

mgagnon 2021-10-21 01:15 trunk
Commit b9107e42cdb3badaae678fff0f7230088fb8907c5b04130937f8404e7bacb85a
1 file changed +31 -21
+31 -21
--- src/login.c
+++ src/login.c
@@ -2116,40 +2116,50 @@
21162116
}
21172117
21182118
/*
21192119
** COMMAND: login-group*
21202120
**
2121
-** Usage: %fossil login-group
2122
-** or: %fossil login-group join REPO [-name NAME]
2123
-** or: %fossil login-group leave
2124
-**
2125
-** With no arguments, this command shows the login-group to which the
2126
-** repository belongs.
2127
-**
2128
-** The "join" command adds this repository to login group to which REPO
2129
-** belongs, or creates a new login group between itself and REPO if REPO
2130
-** does not already belong to a login-group. When creating a new login-
2131
-** group, the name of the new group is determined by the "--name" option.
2132
-**
2133
-** The "leave" command takes the repository out of whatever login group
2134
-** it is currently a part of.
2121
+** Usage: %fossil login-group ?SUBCOMMAND? ?OPTIONS?
2122
+**
2123
+** Run various subcommands to manage login-group related settings of the open
2124
+** repository or of the repository identified by the -R or --repository option.
2125
+**
2126
+** > fossil login-group
2127
+**
2128
+** Show the login-group to which the repository belongs.
2129
+**
2130
+** > fossil login-group join ?--name NAME?
2131
+**
2132
+** Add this repository to login group to which REPO belongs, or creates a
2133
+** new login group between itself and REPO if REPO does not already belong
2134
+** to a login-group. When creating a new login-group, the name of the new
2135
+** group is determined by the "--name" option.
2136
+**
2137
+** > fossil login-group leave
2138
+**
2139
+** Takes the repository out of whatever login group it is currently
2140
+** a part of.
2141
+**
2142
+** Options valid for all subcommands:
2143
+**
2144
+** -R|--repository REPO Run commands on repository REPO
21352145
**
21362146
** About Login Groups:
2137
-**
2138
-** A login-group is a set of repositories that share user credentials.
2147
+**
2148
+** A login-group is a set of repositories that share user credentials.
21392149
** If a user is logged into one member of the group, then that user can
2140
-** access any other group member as long as they have an entry in the
2141
-** USER table of that member. If a user changes their password using
2142
-** web interface, their password is also automatically changed in every
2143
-** other member of the login group.
2150
+** access any other group member as long as they have an entry in the USER
2151
+** table of that member. If a user changes their password using web
2152
+** interface, their password is also automatically changed in every other
2153
+** member of the login group.
21442154
*/
21452155
void login_group_command(void){
21462156
const char *zLGName;
21472157
const char *zCmd;
21482158
int nCmd;
21492159
Stmt q;
2150
- db_find_and_open_repository(0,0);
2160
+ db_find_and_open_repository(0, 0);
21512161
if( g.argc>2 ){
21522162
zCmd = g.argv[2];
21532163
nCmd = (int)strlen(zCmd);
21542164
if( strncmp(zCmd,"join",nCmd)==0 && nCmd>=1 ){
21552165
const char *zNewName = find_option("name",0,1);
21562166
--- src/login.c
+++ src/login.c
@@ -2116,40 +2116,50 @@
2116 }
2117
2118 /*
2119 ** COMMAND: login-group*
2120 **
2121 ** Usage: %fossil login-group
2122 ** or: %fossil login-group join REPO [-name NAME]
2123 ** or: %fossil login-group leave
2124 **
2125 ** With no arguments, this command shows the login-group to which the
2126 ** repository belongs.
2127 **
2128 ** The "join" command adds this repository to login group to which REPO
2129 ** belongs, or creates a new login group between itself and REPO if REPO
2130 ** does not already belong to a login-group. When creating a new login-
2131 ** group, the name of the new group is determined by the "--name" option.
2132 **
2133 ** The "leave" command takes the repository out of whatever login group
2134 ** it is currently a part of.
 
 
 
 
 
 
 
 
 
 
2135 **
2136 ** About Login Groups:
2137 **
2138 ** A login-group is a set of repositories that share user credentials.
2139 ** If a user is logged into one member of the group, then that user can
2140 ** access any other group member as long as they have an entry in the
2141 ** USER table of that member. If a user changes their password using
2142 ** web interface, their password is also automatically changed in every
2143 ** other member of the login group.
2144 */
2145 void login_group_command(void){
2146 const char *zLGName;
2147 const char *zCmd;
2148 int nCmd;
2149 Stmt q;
2150 db_find_and_open_repository(0,0);
2151 if( g.argc>2 ){
2152 zCmd = g.argv[2];
2153 nCmd = (int)strlen(zCmd);
2154 if( strncmp(zCmd,"join",nCmd)==0 && nCmd>=1 ){
2155 const char *zNewName = find_option("name",0,1);
2156
--- src/login.c
+++ src/login.c
@@ -2116,40 +2116,50 @@
2116 }
2117
2118 /*
2119 ** COMMAND: login-group*
2120 **
2121 ** Usage: %fossil login-group ?SUBCOMMAND? ?OPTIONS?
2122 **
2123 ** Run various subcommands to manage login-group related settings of the open
2124 ** repository or of the repository identified by the -R or --repository option.
2125 **
2126 ** > fossil login-group
2127 **
2128 ** Show the login-group to which the repository belongs.
2129 **
2130 ** > fossil login-group join ?--name NAME?
2131 **
2132 ** Add this repository to login group to which REPO belongs, or creates a
2133 ** new login group between itself and REPO if REPO does not already belong
2134 ** to a login-group. When creating a new login-group, the name of the new
2135 ** group is determined by the "--name" option.
2136 **
2137 ** > fossil login-group leave
2138 **
2139 ** Takes the repository out of whatever login group it is currently
2140 ** a part of.
2141 **
2142 ** Options valid for all subcommands:
2143 **
2144 ** -R|--repository REPO Run commands on repository REPO
2145 **
2146 ** About Login Groups:
2147 **
2148 ** A login-group is a set of repositories that share user credentials.
2149 ** If a user is logged into one member of the group, then that user can
2150 ** access any other group member as long as they have an entry in the USER
2151 ** table of that member. If a user changes their password using web
2152 ** interface, their password is also automatically changed in every other
2153 ** member of the login group.
2154 */
2155 void login_group_command(void){
2156 const char *zLGName;
2157 const char *zCmd;
2158 int nCmd;
2159 Stmt q;
2160 db_find_and_open_repository(0, 0);
2161 if( g.argc>2 ){
2162 zCmd = g.argv[2];
2163 nCmd = (int)strlen(zCmd);
2164 if( strncmp(zCmd,"join",nCmd)==0 && nCmd>=1 ){
2165 const char *zNewName = find_option("name",0,1);
2166

Keyboard Shortcuts

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