sloum
/
gfu
1
1
Fork 1
Code Issues Pull Requests Releases 1 Wiki Activity

Added flag for print only function plus docs #2

Manually merged
sloum merged 1 commits from asdf/gfu:output_stdout into master 2019-09-17 15:42:26 +00:00
Conversation 0 Commits 1 Files Changed 3 +85 -16
asdf commented 2019-09-17 10:51:24 +00:00
Collaborator
Copy Link

This PR is to add a print only flag, -stdout

Using the -stdout flag means that any changes to a file are printed to stdout instead of being written to that file.

This is useful for seeing how a file might change, performing troubleshooting, and also for redirection.

While the functionality change is small, the bulk of work has been in updating the documentation. It is a bit out of scope for this change, but I wanted to spend some time learning. The changes are:

  • Updated README.rm (additions based on bombadillo's README.rm)
  • Added package comments in main.go, for use with go doc
  • Amended gfu --help

The package comments could be moved to a standalone doc if they are too big to fit in main.go

Also, if I can figure out if/how man pages can be integrated in to the package, I'll try that too.

This PR is to add a print only flag, `-stdout` Using the `-stdout` flag means that any changes to a file are printed to stdout instead of being written to that file. This is useful for seeing how a file might change, performing troubleshooting, and also for redirection. While the functionality change is small, the bulk of work has been in updating the documentation. It is a bit out of scope for this change, but I wanted to spend some time learning. The changes are: - Updated README.rm (additions based on bombadillo's README.rm) - Added package comments in main.go, for use with `go doc` - Amended `gfu --help` The package comments could be moved to a standalone doc if they are too big to fit in main.go Also, if I can figure out if/how man pages can be integrated in to the package, I'll try that too.
sloum approved these changes 2019-09-17 15:42:14 +00:00
sloum left a comment
Owner
Copy Link

This all looks really great! I had not thought of piping, but can totslly see use cases. A great addition. The comment and help cleanup/buildup is great too. :)

This all looks really great! I had not thought of piping, but can totslly see use cases. A great addition. The comment and help cleanup/buildup is great too. :)
.gitignore
@ -0,0 +1 @@
gfu
sloum commented 2019-09-17 15:26:28 +00:00
Owner
Copy Link

Awesome. I am surprised I had not done this already. THanks for adding it :thumbsup

Awesome. I am surprised I had not done this already. THanks for adding it :thumbsup
README.md
@ -21,1 +55,4 @@
If you would like to get involved, please submit an issue. At present the developers use the tildegit issues system to discuss new features, track bugs, and communicate with users about hopes and/or issues for/with the software.
## License
This project is not currently licensed.
sloum commented 2019-09-17 15:30:54 +00:00
Owner
Copy Link

I would be fine with GPLv3 for this. Or maybe one of the public domain licenses. I have been unable to find a license that fits my actual desires for licensing (an apparently non-free license that restricts use to non-commercial purposes but is otherwise free/libre).

I would be fine with GPLv3 for this. Or maybe one of the public domain licenses. I have been unable to find a license that fits my actual desires for licensing (an apparently non-free license that restricts use to non-commercial purposes but is otherwise free/libre).
sloum closed this pull request 2019-09-17 15:42:26 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No Label
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: sloum/gfu#2
No description provided.
Delete Branch "asdf/gfu:output_stdout"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?