Fossil SCM
A number of small changes. Output may be minimised in a future update.
Commit
27adc8b0c747f3673bc4fca708c64543a3417b60470d38ba30b73df92211cd01
Parent
704b75e853b7e1d…
1 file changed
+41
-17
+41
-17
| --- tools/fossil-makeinfo | ||
| +++ tools/fossil-makeinfo | ||
| @@ -53,10 +53,11 @@ | ||
| 53 | 53 | printf "@contents\n |
| 54 | 54 | |
| 55 | 55 | " >> fossil.texi |
| 56 | 56 | |
| 57 | 57 | # Check fossil version. Only thing wrong with this is which fossil binary is picked up first. |
| 58 | +# Older versions of fossil didn't have a version number, just a truncated commit hash. | |
| 58 | 59 | fossil version | sed 's/This is fossil version /@set VERSION /' | cut -c1-17 >> fossil.texi |
| 59 | 60 | |
| 60 | 61 | # Insert repeat of Top node for PDF. We have to hack to do this |
| 61 | 62 | printf "@ifnotinfo |
| 62 | 63 | @ifnothtml |
| @@ -83,12 +84,12 @@ | ||
| 83 | 84 | @menu |
| 84 | 85 | * Fossil:: Introduction and features listed from the website front page. |
| 85 | 86 | * Common commands:: These are the commands that are most likely to be used. |
| 86 | 87 | * Uncommon commands:: These aren't used as often, but they're still there when needed. |
| 87 | 88 | * Test commands:: These are definitely not recommended for production use. |
| 88 | -* Common arguments:: -o arguments common to all commands | |
| 89 | -* License:: The license agreement of the fossil project | |
| 89 | +* Common arguments:: arguments common to all commands. | |
| 90 | +* License:: The license agreement of the fossil project. | |
| 90 | 91 | @end menu |
| 91 | 92 | |
| 92 | 93 | Help is available for any of the available fossil commands by using: |
| 93 | 94 | |
| 94 | 95 | @example |
| @@ -144,30 +145,37 @@ | ||
| 144 | 145 | - Uses the 2-clause BSD license. |
| 145 | 146 | @end enumerate |
| 146 | 147 | " >> fossil.texi |
| 147 | 148 | |
| 148 | 149 | ###### Common commands |
| 150 | +echo "List common commands" | |
| 151 | + | |
| 149 | 152 | printf "@node Common commands,Uncommon commands,Fossil,Top |
| 150 | 153 | @chapter Common commands |
| 151 | 154 | |
| 152 | -These are the more commonly used commands for the average fossil user. | |
| 155 | +These are the more commonly used commands for the average fossil user. They're | |
| 156 | +listed by fossil when you run the command: | |
| 157 | + | |
| 158 | +@example | |
| 159 | +fossil help | |
| 160 | +@end example | |
| 153 | 161 | |
| 154 | 162 | They are similar to commands that are available in other VCS programs such as |
| 155 | 163 | subversion, git or mercurial. |
| 156 | 164 | |
| 157 | 165 | " >> fossil.texi |
| 158 | 166 | |
| 159 | 167 | # begin menu for common keywords |
| 160 | -echo "@menu" >> fossil.texi | |
| 168 | +printf "@menu" >> fossil.texi | |
| 161 | 169 | |
| 162 | 170 | # Slurp in Common keywords from fossil help |
| 163 | 171 | # WARNING: tail count is brittle |
| 164 | 172 | echo "Grab common keywords" |
| 165 | 173 | for u in $(for t in $(fossil help | tail -n +4| sed '$d'); do echo "$t"; done | sort); do echo "* ${u}::"; done >> fossil.texi |
| 166 | 174 | |
| 167 | 175 | # Add end menu, add some space too |
| 168 | -echo -ne "@end menu | |
| 176 | +printf "@end menu | |
| 169 | 177 | |
| 170 | 178 | " >> fossil.texi |
| 171 | 179 | |
| 172 | 180 | # Add in the actual help for common commands |
| 173 | 181 | # WARNING: tail count is brittle |
| @@ -200,18 +208,25 @@ | ||
| 200 | 208 | sed -i -e 's/|--\([[:alnum:]-]\{1,\}\)/|@option\{--\1\}/g' workfile |
| 201 | 209 | # turns -switches into @option{-switches}. Usually starts with space |
| 202 | 210 | sed -i -e 's/ -\([[:alnum:]-]\{1,\}\)/ @option\{-\1\}/g' workfile |
| 203 | 211 | # ... and adds it to the output file with some space |
| 204 | 212 | cat workfile >> fossil.texi |
| 205 | -echo "" >> fossil.texi | |
| 206 | 213 | |
| 207 | 214 | ##### Uncommon commands #### |
| 208 | -echo "@node Uncommon commands,Test commands,Common commands,Top | |
| 215 | +echo "List uncommon commands" | |
| 216 | +printf " | |
| 217 | +@node Uncommon commands,Test commands,Common commands,Top | |
| 209 | 218 | @chapter Uncommon commands |
| 210 | 219 | |
| 211 | -These are commands that aren't used quite as often, and are normally | |
| 212 | -used in specific circumstances, such as creating fossils suitable for hosting. | |
| 220 | +These are auxiliary commands, listed by fossil when you run the command: | |
| 221 | + | |
| 222 | +@example | |
| 223 | +fossil help -x | |
| 224 | +@end example | |
| 225 | + | |
| 226 | +They're not used quite as often, and are normally used in specific | |
| 227 | +circumstances, such as creating fossils suitable for hosting. | |
| 213 | 228 | |
| 214 | 229 | @menu |
| 215 | 230 | " >> fossil.texi |
| 216 | 231 | |
| 217 | 232 | # Slurp in auxiliary/uncommon keywords - no need to remove last line here |
| @@ -250,20 +265,26 @@ | ||
| 250 | 265 | # ... and adds it to the output file with a spacer line |
| 251 | 266 | cat workfile >> fossil.texi |
| 252 | 267 | echo "" >> fossil.texi |
| 253 | 268 | |
| 254 | 269 | # Now the test commands. Here be dragons. |
| 255 | -echo "Grab test commands" | |
| 270 | +echo "List test commands" | |
| 256 | 271 | echo "@node Test commands,Common arguments,Uncommon commands,Top |
| 257 | 272 | @chapter Testing commands |
| 258 | 273 | |
| 259 | -These are testing commands. They're often used to solve specific little | |
| 260 | -problems that didn't warrant a full tool, but are useful enough to be kept | |
| 261 | -around. They are most definitely not supported, and the developers | |
| 262 | -will expect to change these far more often. They are not stable, so do not | |
| 263 | -depend upon their behavior, or even their existence. | |
| 274 | +These are testing commands, listed by fossil when you run the command: | |
| 275 | + | |
| 276 | +@example | |
| 277 | +fossil help -t | |
| 278 | +@end example | |
| 279 | + | |
| 280 | +They're often used to solve specific little problems that didn't warrant a full | |
| 281 | +tool, but are useful enough to be kept around. They are most definitely not | |
| 282 | +supported, and the developers will expect to change these far more often. They | |
| 283 | +are not stable, so do not depend upon their behavior, or even their existence. | |
| 264 | 284 | |
| 285 | +They're | |
| 265 | 286 | @menu |
| 266 | 287 | " >> fossil.texi |
| 267 | 288 | |
| 268 | 289 | # Insert test commands in here |
| 269 | 290 | echo "Grab test keywords" |
| @@ -304,11 +325,11 @@ | ||
| 304 | 325 | # ... and adds it to the output file with a spacer line |
| 305 | 326 | cat workfile >> fossil.texi |
| 306 | 327 | echo "" >> fossil.texi |
| 307 | 328 | |
| 308 | 329 | # Add in common args |
| 309 | -echo "Grab common args" | |
| 330 | +echo "List common args" | |
| 310 | 331 | echo "@node Common arguments,License,Test commands,Top |
| 311 | 332 | @chapter Common arguments |
| 312 | 333 | |
| 313 | 334 | These are commandline arguments that are common to all fossil commands. |
| 314 | 335 | |
| @@ -334,11 +355,11 @@ | ||
| 334 | 355 | HERE="../COPYRIGHT-BSD2.txt" |
| 335 | 356 | else |
| 336 | 357 | echo "Where's COPYRIGHT-BSD2.txt?" |
| 337 | 358 | fi |
| 338 | 359 | # TODO: This should fail if we couldn't find COPYRIGHT-BSD2.txt |
| 339 | -echo " | |
| 360 | +printf " | |
| 340 | 361 | @node License,,Common arguments,Top |
| 341 | 362 | @chapter License agreement |
| 342 | 363 | |
| 343 | 364 | @include ${HERE} |
| 344 | 365 | |
| @@ -349,6 +370,9 @@ | ||
| 349 | 370 | |
| 350 | 371 | # and now we make the final info file - commented out for now |
| 351 | 372 | # makeinfo fossil.texi |
| 352 | 373 | |
| 353 | 374 | echo "Done ... for now. Please check fossil.texi file over for inconsistencies, and fill in descriptions." |
| 375 | +echo "Once everything's good, you can run your system's makeinfo command to turn" | |
| 376 | +echo "your .texi file into .info file to install where you need" | |
| 377 | + | |
| 354 | 378 | |
| 355 | 379 |
| --- tools/fossil-makeinfo | |
| +++ tools/fossil-makeinfo | |
| @@ -53,10 +53,11 @@ | |
| 53 | printf "@contents\n |
| 54 | |
| 55 | " >> fossil.texi |
| 56 | |
| 57 | # Check fossil version. Only thing wrong with this is which fossil binary is picked up first. |
| 58 | fossil version | sed 's/This is fossil version /@set VERSION /' | cut -c1-17 >> fossil.texi |
| 59 | |
| 60 | # Insert repeat of Top node for PDF. We have to hack to do this |
| 61 | printf "@ifnotinfo |
| 62 | @ifnothtml |
| @@ -83,12 +84,12 @@ | |
| 83 | @menu |
| 84 | * Fossil:: Introduction and features listed from the website front page. |
| 85 | * Common commands:: These are the commands that are most likely to be used. |
| 86 | * Uncommon commands:: These aren't used as often, but they're still there when needed. |
| 87 | * Test commands:: These are definitely not recommended for production use. |
| 88 | * Common arguments:: -o arguments common to all commands |
| 89 | * License:: The license agreement of the fossil project |
| 90 | @end menu |
| 91 | |
| 92 | Help is available for any of the available fossil commands by using: |
| 93 | |
| 94 | @example |
| @@ -144,30 +145,37 @@ | |
| 144 | - Uses the 2-clause BSD license. |
| 145 | @end enumerate |
| 146 | " >> fossil.texi |
| 147 | |
| 148 | ###### Common commands |
| 149 | printf "@node Common commands,Uncommon commands,Fossil,Top |
| 150 | @chapter Common commands |
| 151 | |
| 152 | These are the more commonly used commands for the average fossil user. |
| 153 | |
| 154 | They are similar to commands that are available in other VCS programs such as |
| 155 | subversion, git or mercurial. |
| 156 | |
| 157 | " >> fossil.texi |
| 158 | |
| 159 | # begin menu for common keywords |
| 160 | echo "@menu" >> fossil.texi |
| 161 | |
| 162 | # Slurp in Common keywords from fossil help |
| 163 | # WARNING: tail count is brittle |
| 164 | echo "Grab common keywords" |
| 165 | for u in $(for t in $(fossil help | tail -n +4| sed '$d'); do echo "$t"; done | sort); do echo "* ${u}::"; done >> fossil.texi |
| 166 | |
| 167 | # Add end menu, add some space too |
| 168 | echo -ne "@end menu |
| 169 | |
| 170 | " >> fossil.texi |
| 171 | |
| 172 | # Add in the actual help for common commands |
| 173 | # WARNING: tail count is brittle |
| @@ -200,18 +208,25 @@ | |
| 200 | sed -i -e 's/|--\([[:alnum:]-]\{1,\}\)/|@option\{--\1\}/g' workfile |
| 201 | # turns -switches into @option{-switches}. Usually starts with space |
| 202 | sed -i -e 's/ -\([[:alnum:]-]\{1,\}\)/ @option\{-\1\}/g' workfile |
| 203 | # ... and adds it to the output file with some space |
| 204 | cat workfile >> fossil.texi |
| 205 | echo "" >> fossil.texi |
| 206 | |
| 207 | ##### Uncommon commands #### |
| 208 | echo "@node Uncommon commands,Test commands,Common commands,Top |
| 209 | @chapter Uncommon commands |
| 210 | |
| 211 | These are commands that aren't used quite as often, and are normally |
| 212 | used in specific circumstances, such as creating fossils suitable for hosting. |
| 213 | |
| 214 | @menu |
| 215 | " >> fossil.texi |
| 216 | |
| 217 | # Slurp in auxiliary/uncommon keywords - no need to remove last line here |
| @@ -250,20 +265,26 @@ | |
| 250 | # ... and adds it to the output file with a spacer line |
| 251 | cat workfile >> fossil.texi |
| 252 | echo "" >> fossil.texi |
| 253 | |
| 254 | # Now the test commands. Here be dragons. |
| 255 | echo "Grab test commands" |
| 256 | echo "@node Test commands,Common arguments,Uncommon commands,Top |
| 257 | @chapter Testing commands |
| 258 | |
| 259 | These are testing commands. They're often used to solve specific little |
| 260 | problems that didn't warrant a full tool, but are useful enough to be kept |
| 261 | around. They are most definitely not supported, and the developers |
| 262 | will expect to change these far more often. They are not stable, so do not |
| 263 | depend upon their behavior, or even their existence. |
| 264 | |
| 265 | @menu |
| 266 | " >> fossil.texi |
| 267 | |
| 268 | # Insert test commands in here |
| 269 | echo "Grab test keywords" |
| @@ -304,11 +325,11 @@ | |
| 304 | # ... and adds it to the output file with a spacer line |
| 305 | cat workfile >> fossil.texi |
| 306 | echo "" >> fossil.texi |
| 307 | |
| 308 | # Add in common args |
| 309 | echo "Grab common args" |
| 310 | echo "@node Common arguments,License,Test commands,Top |
| 311 | @chapter Common arguments |
| 312 | |
| 313 | These are commandline arguments that are common to all fossil commands. |
| 314 | |
| @@ -334,11 +355,11 @@ | |
| 334 | HERE="../COPYRIGHT-BSD2.txt" |
| 335 | else |
| 336 | echo "Where's COPYRIGHT-BSD2.txt?" |
| 337 | fi |
| 338 | # TODO: This should fail if we couldn't find COPYRIGHT-BSD2.txt |
| 339 | echo " |
| 340 | @node License,,Common arguments,Top |
| 341 | @chapter License agreement |
| 342 | |
| 343 | @include ${HERE} |
| 344 | |
| @@ -349,6 +370,9 @@ | |
| 349 | |
| 350 | # and now we make the final info file - commented out for now |
| 351 | # makeinfo fossil.texi |
| 352 | |
| 353 | echo "Done ... for now. Please check fossil.texi file over for inconsistencies, and fill in descriptions." |
| 354 | |
| 355 |
| --- tools/fossil-makeinfo | |
| +++ tools/fossil-makeinfo | |
| @@ -53,10 +53,11 @@ | |
| 53 | printf "@contents\n |
| 54 | |
| 55 | " >> fossil.texi |
| 56 | |
| 57 | # Check fossil version. Only thing wrong with this is which fossil binary is picked up first. |
| 58 | # Older versions of fossil didn't have a version number, just a truncated commit hash. |
| 59 | fossil version | sed 's/This is fossil version /@set VERSION /' | cut -c1-17 >> fossil.texi |
| 60 | |
| 61 | # Insert repeat of Top node for PDF. We have to hack to do this |
| 62 | printf "@ifnotinfo |
| 63 | @ifnothtml |
| @@ -83,12 +84,12 @@ | |
| 84 | @menu |
| 85 | * Fossil:: Introduction and features listed from the website front page. |
| 86 | * Common commands:: These are the commands that are most likely to be used. |
| 87 | * Uncommon commands:: These aren't used as often, but they're still there when needed. |
| 88 | * Test commands:: These are definitely not recommended for production use. |
| 89 | * Common arguments:: arguments common to all commands. |
| 90 | * License:: The license agreement of the fossil project. |
| 91 | @end menu |
| 92 | |
| 93 | Help is available for any of the available fossil commands by using: |
| 94 | |
| 95 | @example |
| @@ -144,30 +145,37 @@ | |
| 145 | - Uses the 2-clause BSD license. |
| 146 | @end enumerate |
| 147 | " >> fossil.texi |
| 148 | |
| 149 | ###### Common commands |
| 150 | echo "List common commands" |
| 151 | |
| 152 | printf "@node Common commands,Uncommon commands,Fossil,Top |
| 153 | @chapter Common commands |
| 154 | |
| 155 | These are the more commonly used commands for the average fossil user. They're |
| 156 | listed by fossil when you run the command: |
| 157 | |
| 158 | @example |
| 159 | fossil help |
| 160 | @end example |
| 161 | |
| 162 | They are similar to commands that are available in other VCS programs such as |
| 163 | subversion, git or mercurial. |
| 164 | |
| 165 | " >> fossil.texi |
| 166 | |
| 167 | # begin menu for common keywords |
| 168 | printf "@menu" >> fossil.texi |
| 169 | |
| 170 | # Slurp in Common keywords from fossil help |
| 171 | # WARNING: tail count is brittle |
| 172 | echo "Grab common keywords" |
| 173 | for u in $(for t in $(fossil help | tail -n +4| sed '$d'); do echo "$t"; done | sort); do echo "* ${u}::"; done >> fossil.texi |
| 174 | |
| 175 | # Add end menu, add some space too |
| 176 | printf "@end menu |
| 177 | |
| 178 | " >> fossil.texi |
| 179 | |
| 180 | # Add in the actual help for common commands |
| 181 | # WARNING: tail count is brittle |
| @@ -200,18 +208,25 @@ | |
| 208 | sed -i -e 's/|--\([[:alnum:]-]\{1,\}\)/|@option\{--\1\}/g' workfile |
| 209 | # turns -switches into @option{-switches}. Usually starts with space |
| 210 | sed -i -e 's/ -\([[:alnum:]-]\{1,\}\)/ @option\{-\1\}/g' workfile |
| 211 | # ... and adds it to the output file with some space |
| 212 | cat workfile >> fossil.texi |
| 213 | |
| 214 | ##### Uncommon commands #### |
| 215 | echo "List uncommon commands" |
| 216 | printf " |
| 217 | @node Uncommon commands,Test commands,Common commands,Top |
| 218 | @chapter Uncommon commands |
| 219 | |
| 220 | These are auxiliary commands, listed by fossil when you run the command: |
| 221 | |
| 222 | @example |
| 223 | fossil help -x |
| 224 | @end example |
| 225 | |
| 226 | They're not used quite as often, and are normally used in specific |
| 227 | circumstances, such as creating fossils suitable for hosting. |
| 228 | |
| 229 | @menu |
| 230 | " >> fossil.texi |
| 231 | |
| 232 | # Slurp in auxiliary/uncommon keywords - no need to remove last line here |
| @@ -250,20 +265,26 @@ | |
| 265 | # ... and adds it to the output file with a spacer line |
| 266 | cat workfile >> fossil.texi |
| 267 | echo "" >> fossil.texi |
| 268 | |
| 269 | # Now the test commands. Here be dragons. |
| 270 | echo "List test commands" |
| 271 | echo "@node Test commands,Common arguments,Uncommon commands,Top |
| 272 | @chapter Testing commands |
| 273 | |
| 274 | These are testing commands, listed by fossil when you run the command: |
| 275 | |
| 276 | @example |
| 277 | fossil help -t |
| 278 | @end example |
| 279 | |
| 280 | They're often used to solve specific little problems that didn't warrant a full |
| 281 | tool, but are useful enough to be kept around. They are most definitely not |
| 282 | supported, and the developers will expect to change these far more often. They |
| 283 | are not stable, so do not depend upon their behavior, or even their existence. |
| 284 | |
| 285 | They're |
| 286 | @menu |
| 287 | " >> fossil.texi |
| 288 | |
| 289 | # Insert test commands in here |
| 290 | echo "Grab test keywords" |
| @@ -304,11 +325,11 @@ | |
| 325 | # ... and adds it to the output file with a spacer line |
| 326 | cat workfile >> fossil.texi |
| 327 | echo "" >> fossil.texi |
| 328 | |
| 329 | # Add in common args |
| 330 | echo "List common args" |
| 331 | echo "@node Common arguments,License,Test commands,Top |
| 332 | @chapter Common arguments |
| 333 | |
| 334 | These are commandline arguments that are common to all fossil commands. |
| 335 | |
| @@ -334,11 +355,11 @@ | |
| 355 | HERE="../COPYRIGHT-BSD2.txt" |
| 356 | else |
| 357 | echo "Where's COPYRIGHT-BSD2.txt?" |
| 358 | fi |
| 359 | # TODO: This should fail if we couldn't find COPYRIGHT-BSD2.txt |
| 360 | printf " |
| 361 | @node License,,Common arguments,Top |
| 362 | @chapter License agreement |
| 363 | |
| 364 | @include ${HERE} |
| 365 | |
| @@ -349,6 +370,9 @@ | |
| 370 | |
| 371 | # and now we make the final info file - commented out for now |
| 372 | # makeinfo fossil.texi |
| 373 | |
| 374 | echo "Done ... for now. Please check fossil.texi file over for inconsistencies, and fill in descriptions." |
| 375 | echo "Once everything's good, you can run your system's makeinfo command to turn" |
| 376 | echo "your .texi file into .info file to install where you need" |
| 377 | |
| 378 | |
| 379 |