mirror/ioccc
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #984 from xexyl/sgit-updates

Browse Source 
sgit updates (man page, usage string, README.md)
This commit is contained in:
Landon Curt Noll authored and GitHub committed 2023-09-29 23:37:00 -07:00
2 parents d6b227130a 84d36bff44
commit 3f3bb259a6
4 files changed
+118 -40
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

2000/natori/README.md
+10 -5
View File
@@ -1,9 +1,6 @@
# Best Small Program
NATORI Shin
Univ. of Tokyo
Rigakubu 7-goukan 311
Hongou 7-3-1, Bunkyou-ku, Tokyo
Japan
@@ -20,6 +17,9 @@ make
./natori
```
NOTE: an alternate version exists for those in the southern hemisphere. See the
Alternate code section below for more details.
## Try:
@@ -31,7 +31,7 @@ echo "Do or do not. There is no try."
### Alternate code:
The author noted that those in the southern hemisphere might want to change
`acos(l/2)` into `acos(-l/2)`.
`acos(l/2)` into `acos(-l/2)` which we have done in the alternate version.
To run the alternate code that supports the southern hemisphere:
@@ -41,6 +41,11 @@ make alt
Use `natori.alt` as you would `natori`.
What happens if you run it in the northern hemisphere? Are there any
differences?
Can you identify any Moon phases that result in the same output of both
versions?
## Judges' remarks:
@@ -49,7 +54,7 @@ Can you figure out how it does it?
The ANSI-C committee, among their multiple misdeeds, broke perfectly
fun C programs by making it intractable for them to declare their
own non-traditional prototype for main(). We have had uglify this
own non-traditional prototype for main(). We have had to uglify this
program in order to try and prevent C compilers form failing to
compile due to the unusual arg types of the main() function.
src/sgit/README.md
+29 -26
View File
@@ -1,13 +1,13 @@
# sgit - run sed on files under git control
`sgit` runs `sed(1)` on files that are under git control, based on one or more
globs (either a pattern or an exact file name). Files not under git control in
the directory and any subdirectories will not be touched. Depending on the globs
specified it might or might not recurse into subdirectories. That is the shell
at work, of course. Running it in a directory that is not a git repository is an
error.
globs (either a pattern or an exact file name). Running this from a directory
that is not a git repository is an error and any files not under git control in
the directory will not be touched. Depending on the globs specified it might or
might not recurse into subdirectories. That is the shell at work, of course.
Running it in a directory that is not a git repository is an error.
This is extremely useful because one need not run extra commands to determine
`sgit` is extremely useful because one need not run extra commands to determine
the list of files (which might be very long) and then pass them directly to
`sed(1)`.
@@ -24,21 +24,25 @@ Note that you **MUST** pass the `-` to the option and for long options like
`--posix` you must pass `--`! In other words use the options like you would with
`sed` but prefixing it with `-o` first. This was a stylistic choice but it
allows one to quote the option arg to pass more than one option instead of
having to use `sgit -o` more than once. Note that not all options to `sed` have
been tested. If the option requires an arg or you want to pass more than one
option you must quote it.
having to use `sgit -o` more than once though you can certainly use the option
more than once. Note that not all options to `sed` have been tested. If the
option requires a space (say for an arg) or you want to pass more than one
option separated by a space and you only use one `-o` you must quote it.
By default it does **in-place editing; it does NOT backup files**. If you
By default it does **in-place editing and it does NOT backup files**. If you
wish to not edit the file in place (see examples later in this file) you can use
the `sgit -I` option. Note that the `-n` option (`sgit -o -n`) without `sgit -I`
can, depending on the sed commands, empty files! This is analogous to using both
`-n` and `-i` to `sed` which would do in-place editing without automatic
printing of the pattern space.
printing of the pattern space. An example is provided later.
If you wish to provide a backup extension for editing files use `sgit -i`. See
example below. Note that using `-i` overwrites existing backup files and it will
also create a file for each file edited. This means that if it ends up editing
50 files there will be 50 new files created.
also create or update a file for each file edited. This means that if it ends up
editing 50 files without a backup file (with the extension provided) there will
be 50 new files created. Using this option might be of limited use, of course,
since files under git control can be restored, compared etc. but it's there in
case one wants it.
See the usage below or run `sgit` by itself (or with the `-h` option) to see the
rest of the options.
@@ -58,28 +62,27 @@ usage: sgit [-h] [-V] [-v level] [-x] [-I] [-i extension] [-o sed_option] [-s se
-I disable in place editing
-i extension set backup extension (default none)
WARNING: sed -i overwrites existing files
WARNING: this will create another file for each file changed
WARNING: sed -i overwrites existing backup files
WARNING: this will create or update a file for each file changed
-o sed_option append sed options to options list
-o sed_option append sed option or options to options list
WARNING: use of '-o -n' without '-I', can depending on
sed commands, empty files as if both sed -i and sed -n were
used together
NOTE: you must pass the '-' for short options and '--' for long options!
NOTE: if you pass more than one option or it takes an option arg you must
quote it!
NOTE: if you need a space in an option you should quote it!
-s sed set path to sed
-e command append sed command to list of commands to execute on globs
sgit version: 0.0.11-1 28-04-2023
sgit version: 0.0.12-1 29-04-2023
```
You **MUST** specify at least one `sed` command and one glob: the sed command by
way of the `-e` option (just like with `sed`); anything after the last option is
a glob. You may specify more than one of each. Specify `-e` for each command.
The sed commands is an array just like the sed options.
You **MUST** specify at least one `sed` command and one glob: the `sed` command
by way of the `-e` option (just like with `sed`); anything after the last option
is a glob. You may specify more than one of each. Specify `-e` for each command.
The `sed` commands is an array just like the `sed` options.
## A note about the `-i` option and backup extensions
@@ -93,7 +96,7 @@ option .. I'm looking at you, BSD/macOS `sed`).
## `sgit -i` WARNING: each file edited will result in another file in the working directory
Of course if you have 50 files that are edited then 50 new files will be
created just like with `sed` itself.
created (or otherwise updated) just like with `sed` itself.
# `sgit -i` WARNING: this **WILL OVERWRITE EXISTING BACKUP FILES**!
@@ -136,13 +139,13 @@ man ./sgit.1
## Examples
### Change in this file (_IN MEMORY ONLY_) `\<sed\>` to `used` but only show lines changed:
### Change references (_**IN MEMORY ONLY**_ i.e. WITHOUT in-place editing) of the exact word `sed` (as in `\<sed\>`) in this file but only show changed lines
```sh
sgit -I -o -n -e 's/\<sed\>/used/p' README.md
```
### Print out matches of `\<sed\>` in all files under git control
### Print out matches of the EXACT word `sed` (as in `\<sed\>`) in all files under git control from the current working directory
This is a simpler way of running `git --no-pager grep -h -E '\<sed\>'|sed
's/^[0-9]*://g'` which itself might or might not be more complicated than it
src/sgit/sgit.1
+72 -3
View File
@@ -4,7 +4,7 @@
.\"
.\" Dedicated to my wonderful Mum and to my dear cousin Dani.
.\"
.TH sgit 1 "28 September 2023" "sgit" "IOCCC tools"
.TH sgit 1 "29 September 2023" "sgit" "IOCCC tools"
.SH NAME
.B sgit
\- run
@@ -75,6 +75,9 @@ Any text after the final option is considered a glob.
At least one
.BR sed (1)
command and one glob must be specified.
A glob of
.I .
will match all files under git control from the current working directory.
If you run the command from a directory that is not a
.BR git (1)
repo it is an error.
@@ -99,9 +102,9 @@ Disable in place editing
Set backup extension (default none)
.RS
.PP
WARNING: sed \-i overwrites existing files
WARNING: sed \-i overwrites existing backup files
.br
WARNING: this will create another file for each file changed
WARNING: this will create or update a file for each file changed
.RE
.TP
.BI \-o\ sed_option
@@ -125,6 +128,8 @@ and
were used together
.br
NOTE: you must pass the '-' for short options and '--' for long options!
.br
NOTE: if you need a space in an option you should quote it!
.RE
.TP
.BI \-s\ sed
@@ -170,3 +175,67 @@ On a more serious note there are no known bugs but if you have an issue with the
You can find it at
.br
.IR <https://github.com/xexyl/sgit/issues> .
.SH EXAMPLES
.PP
Change references (\c
.B IN MEMORY ONLY
i.e. \fBWITHOUT in\-place editing\fP\c
) of the exact word
.B sed
(as in \c
.BR \\\\<sed\\\\> )
in the
.B sgit
script to
.B used
but only show changed lines:
.IR
.sp
.RS
.ft B
sgit -I -o -n -e 's/\<sed\>/used/p' sgit
.ft R
.RE
.PP
Print out matches of the exact word
.B sed
(as in \c
.BR \\\\<sed\\\\> )
in all files under
.BR git (1)
control from the current working directory:
.IR
.sp
.RS
.ft B
sgit -I -o -n -e '/\<sed\>/p' .
.ft R
.sp
.RE
The above is a simpler way of running:
.IR
.sp
.RS
.ft B
git --no-pager grep -h -E '\<sed\>'|sed 's/^[0-9]*://g'
.ft R
.RE
.sp
.PP
With tracing enabled, change references of the exact word
.B sed
(as in \c
.BR \\\\<sed\\\\> )
in this file and save it:
.sp
.RS
.ft B
sgit -e 's/\<sed\>/used/g' -x sgit.1
.ft R
.RE
.PP
For more examples see the following link:
.IR \<https://github.com/xexyl/sgit#examples\>
.SH SEE ALSO
For additional details including the history, script history and other things about the tool, see:
.IR \<https://github.com/xexyl/sgit#readme\>
src/sgit/sgit.sh
+7 -6
View File
@@ -18,10 +18,12 @@
# creating many additional files (if backing up the files for instance with the
# -i option).
#
# A man page also exists for this tool as sgit.1.
#
# - Cody Boone Ferguson (@xexyl)
#
export SGIT_VERSION="0.0.11-1 28-04-2023" # format: major.minor.patch-release DD-MM-YYYY
export SGIT_VERSION="0.0.12-1 29-04-2023" # format: major.minor.patch-release DD-MM-YYYY
USAGE="usage: $(basename "$0") [-h] [-V] [-v level] [-x] [-I] [-i extension] [-o sed_option] [-s sed] [-e command] <glob...>
@@ -32,17 +34,16 @@ USAGE="usage: $(basename "$0") [-h] [-V] [-v level] [-x] [-I] [-i extension] [-o
-I disable in place editing
-i extension set backup extension (default none)
WARNING: sed -i overwrites existing files
WARNING: this will create another file for each file changed
WARNING: sed -i overwrites existing backup files
WARNING: this will create or update a file for each file changed
-o sed_option append sed options to options list
-o sed_option append sed option or options to options list
WARNING: use of '-o -n' without '-I', can depending on
sed commands, empty files as if both sed -i and sed -n were
used together
NOTE: you must pass the '-' for short options and '--' for long options!
NOTE: if you pass more than one option or it takes an option arg you must
quote it!
NOTE: if you need a space in an option you should quote it!
-s sed set path to sed
-e command append sed command to list of commands to execute on globs