diff options
| -rw-r--r-- | doc/ChangeLog | 4 | ||||
| -rw-r--r-- | doc/gawkworkflow.info | 144 | ||||
| -rw-r--r-- | doc/gawkworkflow.texi | 35 |
3 files changed, 102 insertions, 81 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index 0a2f5ae7..af2b96fe 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2020-05-15 Arnold D. Robbins <arnold@skeeve.com> + + * gawkworkflow.texi: Minor updates. + 2020-05-08 Arnold D. Robbins <arnold@skeeve.com> * gawkinet.texi: Remove special casing for statist image for diff --git a/doc/gawkworkflow.info b/doc/gawkworkflow.info index 6a1549e7..5977aff1 100644 --- a/doc/gawkworkflow.info +++ b/doc/gawkworkflow.info @@ -1,10 +1,10 @@ -This is gawkworkflow.info, produced by makeinfo version 6.5 from +This is gawkworkflow.info, produced by makeinfo version 6.7 from gawkworkflow.texi. Copyright (C) 2017, 2018, 2019 Free Software Foundation, Inc. - This is Edition 0.72 of 'Participating in 'gawk' Development'. + This is Edition 0.73 of 'Participating in 'gawk' Development'. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or @@ -38,7 +38,7 @@ Awk ('gawk') (http://www.gnu.org/software/gawk). Copyright (C) 2017, 2018, 2019 Free Software Foundation, Inc. - This is Edition 0.72 of 'Participating in 'gawk' Development'. + This is Edition 0.73 of 'Participating in 'gawk' Development'. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or @@ -211,7 +211,7 @@ File: gawkworkflow.info, Node: Acknowledgments, Next: Reviewers, Prev: Conven Acknowledgments =============== -Thanks to Ju"rgen Kahrs for his initial efforts to write a document like +Thanks to Jürgen Kahrs for his initial efforts to write a document like this. Although his prose has not survived, his material was helpful in preparing this Info file. @@ -455,9 +455,9 @@ branches: the upstream. You use the branch name without the leading 'origin/' prefix. For example, 'git checkout gawk-4.1-stable'. - You can then work on this branch, making commitments to it as you - wish. Once things are ready to move upstream, you simply use 'git - push', and your changes will be pushed up to the main repo.(1) + You can then work on this branch, making commits to it as you wish. + Once things are ready to move upstream, you simply use 'git push', + and your changes will be pushed up to the main repo.(1) You should *never* checkout a branch using the 'origin/' prefix. Things will get very confused. Always work on local tracking @@ -773,12 +773,13 @@ File: gawkworkflow.info, Node: Switching Branches, Next: Starting A New Branch So far, we've been working in the default 'master' branch. Let's check what's happening in the 'gawk-4.1-stable' branch: - $ make distclean Clean up - $ git checkout gawk-4.1-stable Checkout a different branch + $ make distclean Clean up + $ git checkout gawk-4.1-stable Checkout a different branch -| ... - $ git pull Get up to date + $ git pull Get up to date -| ... - $ ./bootstrap.sh && ./configure && make -j && make check Start working + $ ./bootstrap.sh && ./configure && Start working + > make -j && make check File: gawkworkflow.info, Node: Starting A New Branch, Next: Undoing a change, Prev: Switching Branches, Up: Development without commit access @@ -1116,7 +1117,7 @@ directly on 'master'. Here's how to commit your changes: $ git diff Review the patch one more time $ git add ... Add any files for committing - $ git commit Commit the files. Include a commit message. + $ git commit Commit the files, with a commit message $ git push Push the files up to the repo. Ta da! The first three steps are the same described earlier (*note Starting @@ -1152,7 +1153,7 @@ their local systems and review your changes at their leisure. $ git diff Review your changes $ git add ... Add any files for committing - $ git commit Commit the files. Include a commit message + $ git commit Commit the files with a commit message $ git push -u origin feature/python Push the branch up to the repo When you use 'push -u origin', Git helpfully converts your purely @@ -1182,7 +1183,7 @@ list. Once it's approved, you can commit it yourself: $ gvim ... Make any fixes, compile, test $ git diff Review your changes $ git add ... Add any files for committing - $ git commit Commit the files. Include a commit message. + $ git commit Commit the files with a commit message. When you're ready to push your changes: @@ -1281,8 +1282,11 @@ feature branch. Since 'feature/python' is no longer needed, it can be gotten rid of: - $ git branch -d feature/python Still on master, delete feature branch - $ git push -u origin --delete feature/python Delete the branch on Savannah + $ git branch Still on master + ... + * master + $ git branch -d feature/python Delete feature branch + $ git push -u origin --delete feature/python Delete on Savannah The 'git push' command deletes the 'feature/python' branch from the Savannah repo. @@ -1341,7 +1345,7 @@ _Removing cruft_ _Renaming branches_ Occasionally you may want to rename a branch.(1) If your branch is - local and you are on it, us: + local and you are on it, use: $ git branch -m feature/NEW-NAME @@ -1543,7 +1547,8 @@ _The (Revived) Portable C Compiler_ An alternative location for the source is the 'gawk' maintainer's Git mirror (https://github.com/arnoldrobbins/pcc-revived) of the - code. + code. If you're using Ubuntu GNU/Linux 18.04 or later, you need to + use the 'ubuntu-18' branch from this Git mirror. ---------- Footnotes ---------- @@ -1564,7 +1569,7 @@ for 'extensions/Makefile'. Then run 'make'. '.developing' in the 'gawk' source code directory _before_ running 'configure'. Doing so enables additional conditionally-compiled debugging code within 'gawk', and adds additional warning and debugging -options if compiling with GCC. +options if compiling with GCC. It also disables optimization. File: gawkworkflow.info, Node: Cheat Sheet, Next: Resources, Prev: Development Stuff, Up: Top @@ -1812,7 +1817,7 @@ Index * git diff <7>: Developing fixes. (line 10) * git difftool: Starting A New Branch. (line 29) -* git fetch: General practices. (line 94) +* git fetch: General practices. (line 97) * git fetch <1>: Repo Maintenance. (line 25) * git format-patch: Submitting Changes. (line 24) * git gc: Repo Maintenance. (line 33) @@ -1864,7 +1869,7 @@ Index * GNU makeinfo: GNU Tools. (line 41) * GNU software tools: GNU Tools. (line 6) * GNU Texinfo: GNU Tools. (line 41) -* Kahrs, Ju"rgen: Acknowledgments. (line 6) +* Kahrs, Jürgen: Acknowledgments. (line 6) * libtool: GNU Tools. (line 34) * local branches: Local Branches. (line 6) * main branch: Repo State. (line 27) @@ -1930,51 +1935,56 @@ Ref: savannah-repo16352 Ref: your-repo17385 Ref: Repo Copies-Footnote-119079 Node: Local Branches19136 -Ref: your-repo-220914 -Ref: Local Branches-Footnote-121995 -Node: Branches are state22053 -Node: Repo State22776 -Node: Local State24896 -Node: Remotes25560 -Node: Configuring git26874 -Ref: Configuring git-Footnote-129227 -Node: Development without commit access29396 -Node: Cloning30398 -Node: Switching Branches32257 -Node: Starting A New Branch32910 -Ref: Starting A New Branch-Footnote-134798 -Ref: Starting A New Branch-Footnote-234856 -Node: Undoing a change34932 -Node: Updating35533 -Node: Rebasing36035 -Node: Merge Conflicts36647 -Node: Submitting Changes38147 -Ref: Submitting Changes-Footnote-140291 -Ref: Submitting Changes-Footnote-240328 -Ref: Submitting Changes-Footnote-340364 -Node: Removing Branches40410 -Node: Points to remember40946 -Node: Development with commit access42623 -Node: Initial setup43268 -Node: ssh clone44056 -Node: Developing patches44653 -Node: Developing new features45989 -Node: Developing fixes47893 -Node: General practices48980 -Node: Repo Maintenance53722 -Ref: Repo Maintenance-Footnote-156491 -Node: Development Stuff56624 -Node: Coding style57187 -Ref: Coding style-Footnote-157845 -Node: Doing paperwork57935 -Node: Tools58730 -Node: GNU Tools59312 -Node: Compilers61473 -Ref: Compilers-Footnote-163967 -Node: Debugging64005 -Node: Cheat Sheet64711 -Node: Resources68398 -Node: TODO68841 -Node: Index69061 +Ref: your-repo-220909 +Ref: Local Branches-Footnote-121990 +Node: Branches are state22048 +Node: Repo State22771 +Node: Local State24891 +Node: Remotes25555 +Node: Configuring git26869 +Ref: Configuring git-Footnote-129222 +Node: Development without commit access29391 +Node: Cloning30393 +Node: Switching Branches32252 +Node: Starting A New Branch32870 +Ref: Starting A New Branch-Footnote-134758 +Ref: Starting A New Branch-Footnote-234816 +Node: Undoing a change34892 +Node: Updating35493 +Node: Rebasing35995 +Node: Merge Conflicts36607 +Node: Submitting Changes38107 +Ref: Submitting Changes-Footnote-140251 +Ref: Submitting Changes-Footnote-240288 +Ref: Submitting Changes-Footnote-340324 +Node: Removing Branches40370 +Node: Points to remember40906 +Node: Development with commit access42583 +Node: Initial setup43228 +Node: ssh clone44016 +Node: Developing patches44613 +Node: Developing new features45945 +Node: Developing fixes47845 +Node: General practices48928 +Node: Repo Maintenance53747 +Ref: Repo Maintenance-Footnote-156517 +Node: Development Stuff56650 +Node: Coding style57213 +Ref: Coding style-Footnote-157871 +Node: Doing paperwork57961 +Node: Tools58756 +Node: GNU Tools59338 +Node: Compilers61499 +Ref: Compilers-Footnote-164109 +Node: Debugging64147 +Node: Cheat Sheet64884 +Node: Resources68571 +Node: TODO69014 +Node: Index69234 End Tag Table + + +Local Variables: +coding: utf-8 +End: diff --git a/doc/gawkworkflow.texi b/doc/gawkworkflow.texi index 65a6cc4c..807c0ea3 100644 --- a/doc/gawkworkflow.texi +++ b/doc/gawkworkflow.texi @@ -28,10 +28,10 @@ @c applies to and all the info about who's publishing this edition @c These apply across the board. -@set UPDATE-MONTH February, 2019 +@set UPDATE-MONTH May, 2020 @set TITLE Participating in @command{gawk} Development -@set EDITION 0.72 +@set EDITION 0.73 @iftex @set DOCUMENT booklet @@ -688,7 +688,7 @@ upstream. You use the branch name without the leading @samp{origin/} prefix. For example, @samp{git checkout gawk-4.1-stable}. @cindex @code{git push} -You can then work on this branch, making commitments to it as you wish. +You can then work on this branch, making commits to it as you wish. Once things are ready to move upstream, you simply use @samp{git push}, and your changes will be pushed up to the main repo.@footnote{Assuming you have permission to do so, of course.} @@ -1048,12 +1048,13 @@ Let's check what's happening in the @code{gawk-4.1-stable} branch: @cindex @code{git checkout} @cindex @code{git pull} @example -$ @kbd{make distclean} @ii{Clean up} -$ @kbd{git checkout gawk-4.1-stable} @ii{Checkout a different branch} +$ @kbd{make distclean} @ii{Clean up} +$ @kbd{git checkout gawk-4.1-stable} @ii{Checkout a different branch} @print{} ... -$ @kbd{git pull} @ii{Get up to date} +$ @kbd{git pull} @ii{Get up to date} @print{} ... -$ @kbd{./bootstrap.sh && ./configure && make -j && make check} @ii{Start working} +$ @kbd{./bootstrap.sh && ./configure &&} @ii{Start working} +> @kbd{make -j && make check} @end example @node Starting A New Branch @@ -1466,7 +1467,7 @@ Here's how to commit your changes: @example $ @kbd{git diff} @ii{Review the patch one more time} $ @kbd{git add @dots{}} @ii{Add any files for committing} -$ @kbd{git commit} @ii{Commit the files. Include a commit message.} +$ @kbd{git commit} @ii{Commit the files, with a commit message} $ @kbd{git push} @ii{Push the files up to the repo. Ta da!} @end example @@ -1509,7 +1510,7 @@ To push your branch up initially: @example $ @kbd{git diff} @ii{Review your changes} $ @kbd{git add @dots{}} @ii{Add any files for committing} -$ @kbd{git commit} @ii{Commit the files. Include a commit message} +$ @kbd{git commit} @ii{Commit the files with a commit message} $ @kbd{git push -u origin feature/python} @ii{Push the branch up to the repo} @end example @@ -1552,7 +1553,7 @@ $ @kbd{git pull} @ii{Make sure we're up to date with the maintain $ @kbd{gvim @dots{}} @ii{Make any fixes, compile, test} $ @kbd{git diff} @ii{Review your changes} $ @kbd{git add @dots{}} @ii{Add any files for committing} -$ @kbd{git commit} @ii{Commit the files. Include a commit message.} +$ @kbd{git commit} @ii{Commit the files with a commit message.} @end example When you're ready to push your changes: @@ -1682,8 +1683,11 @@ gotten rid of: @cindex @code{git branch} @cindex @code{git push} @example -$ @kbd{git branch -d feature/python} @ii{Still on} master@ii{, delete feature branch} -$ @kbd{git push -u origin --delete feature/python} @ii{Delete the branch on Savannah} +$ @kbd{git branch} @ii{Still on} master + @dots{} +* master +$ @kbd{git branch -d feature/python} @ii{Delete feature branch} +$ @kbd{git push -u origin --delete feature/python} @ii{Delete on Savannah} @end example The @samp{git push} command deletes the @code{feature/python} @@ -1767,7 +1771,7 @@ $ @kbd{du -s .} @ii{Check disk usage again} Occasionally you may want to rename a branch.@footnote{This discussion adopted from @uref{https://multiplestates.wordpress.com/2015/02/05/rename-a-local-and-remote-branch-in-git, here}.} -If your branch is local and you are on it, us: +If your branch is local and you are on it, use: @example $ @kbd{git branch -m feature/@var{new-name}} @@ -1999,7 +2003,9 @@ for instructions about obtaining the code using CVS and building it. @cindex @command{pcc} compiler, Git mirror An alternative location for the source is the @command{gawk} maintainer's @uref{https://github.com/arnoldrobbins/pcc-revived, -Git mirror} of the code. +Git mirror} of the code. If you're using Ubuntu GNU/Linux 18.04 +or later, you need to use the @code{ubuntu-18} branch from this +Git mirror. @end table @node Debugging @@ -2019,6 +2025,7 @@ named @file{.developing} in the @command{gawk} source code directory @emph{before} running @command{configure}. Doing so enables additional conditionally-compiled debugging code within @command{gawk}, and adds additional warning and debugging options if compiling with GCC. +It also disables optimization. @node Cheat Sheet @appendix Git Command Cheat Sheet |