summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArnold D. Robbins <arnold@skeeve.com>2023-03-09 19:58:11 +0200
committerArnold D. Robbins <arnold@skeeve.com>2023-03-09 19:58:11 +0200
commit7dc2bd5f4e112faa509f13ff64fb86ec6606f9d4 (patch)
tree666ef2dde457adc36edd2deda715d6e03700ca40
parent361cfd7aabd59f2ebc9bc69492f65f1189e120ca (diff)
downloadgawk-7dc2bd5f4e112faa509f13ff64fb86ec6606f9d4.tar.gz
Updates to gawk workflow doc.
-rw-r--r--doc/ChangeLog9
-rw-r--r--doc/gawkworkflow.info163
-rw-r--r--doc/gawkworkflow.texi17
3 files changed, 106 insertions, 83 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 7316a0cf..7ede4870 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,12 @@
+2023-03-09 Arnold D. Robbins <arnold@skeeve.com>
+
+ * gawkworkflow.texi (UPDATE-MONTH, EDITION): Updated.
+ Copyright, add current year.
+ (Submitting Your Changes): Add a note about diffs for generated
+ files also being in the output of `git diff'. Thanks to Manual
+ Collado for the suggestion.
+ (New feature development): Fix the text of a command.
+
2023-03-09 Manuel Collado <mcollado2011@gmail.com>
* gawktexi.in, gawkinet.texi, *.{png,jpg,eps,pdf,txt,fig}: rename
diff --git a/doc/gawkworkflow.info b/doc/gawkworkflow.info
index 2596ec61..591ca0d6 100644
--- a/doc/gawkworkflow.info
+++ b/doc/gawkworkflow.info
@@ -1,10 +1,11 @@
This is gawkworkflow.info, produced by makeinfo version 7.0.1 from
gawkworkflow.texi.
-Copyright © 2017, 2018, 2019, 2020, 2022 Free Software Foundation, Inc.
+Copyright © 2017, 2018, 2019, 2020, 2022, 2023 Free Software Foundation,
+Inc.
- This is Edition 0.74 of ‘Participating in ‘gawk’ Development’.
+ This is Edition 0.75 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
@@ -35,11 +36,11 @@ General Introduction
This file describes how to participate in software development for GNU
Awk (‘gawk’) (http://www.gnu.org/software/gawk).
- Copyright © 2017, 2018, 2019, 2020, 2022 Free Software Foundation,
-Inc.
+ Copyright © 2017, 2018, 2019, 2020, 2022, 2023 Free Software
+Foundation, Inc.
- This is Edition 0.74 of ‘Participating in ‘gawk’ Development’.
+ This is Edition 0.75 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
@@ -1005,6 +1006,11 @@ _Generate a single large patch_
Mail the ‘python.diff’ file to the appropriate mailing list along
with a description of what you’ve changed and why.
+ The patch file will likely contain changes to generated files, such
+ as ‘awkgram.c’ or ‘Makefile.in’. If you are comfortable manually
+ editing the patch file to remove those changes, do so. If not,
+ then send the file as-is and the maintainer will handle it.
+
_Generate a set of patches that in toto comprise your changes_
To do this, use ‘git format-patch’:
@@ -1164,7 +1170,8 @@ without commit access:
3. If necessary, update the documentation: ‘doc/gawktexi.in’ and/or
‘doc/gawk.1’.
- 4. Use ‘git diff > mychange.diff’ to create a patch file.
+ 4. Use ‘git diff > mychange.diff’ to create a patch file. (If you
+ want, remove the diffs for generated files.)
5. Send it to the mailing list for discussion.
@@ -1281,7 +1288,7 @@ Savannah repo.
otherwise, you should _always_ start branches for new features from
‘master’, and not from the current “stable” branch.
- Use ‘checkout -b feature/FEATURE_NAME’ to create the initial
+ Use ‘git checkout -b feature/FEATURE_NAME’ to create the initial
branch. You may then elect to keep it purely local, or to push it
up to Savannah for review, even if the feature is not yet totally
“ready for prime time.”
@@ -1827,7 +1834,7 @@ Index
* gawktexi.in documentation: Developing patches. (line 13)
* GCC, the GNU Compiler Collection: Compilers. (line 6)
* generating a single patch: Submitting Changes. (line 14)
-* generating multiple patches: Submitting Changes. (line 24)
+* generating multiple patches: Submitting Changes. (line 29)
* gettext: GNU Tools. (line 27)
* git branch command, -a option: Remotes. (line 6)
* git command, git branch: Repo Copies. (line 39)
@@ -1868,8 +1875,8 @@ Index
* git command, git pull <2>: Rebasing. (line 10)
* git command, git checkout <5>: Submitting Changes. (line 18)
* git command, git diff <1>: Submitting Changes. (line 18)
-* git command, git format-patch: Submitting Changes. (line 24)
-* git command, git checkout <6>: Submitting Changes. (line 27)
+* git command, git format-patch: Submitting Changes. (line 29)
+* git command, git checkout <6>: Submitting Changes. (line 32)
* git command, git checkout <7>: Removing Branches. (line 9)
* git command, git pull <3>: Removing Branches. (line 9)
* git command, git branch <1>: Removing Branches. (line 9)
@@ -1883,10 +1890,10 @@ Index
* git command, git merge: Points to remember. (line 37)
* git command, git clone <2>: ssh clone. (line 10)
* git command, git diff <3>: Developing patches. (line 16)
-* git command, git diff <4>: Developing patches. (line 26)
-* git command, git add <1>: Developing patches. (line 26)
-* git command, git commit <1>: Developing patches. (line 26)
-* git command, git push <1>: Developing patches. (line 26)
+* git command, git diff <4>: Developing patches. (line 27)
+* git command, git add <1>: Developing patches. (line 27)
+* git command, git commit <1>: Developing patches. (line 27)
+* git command, git push <1>: Developing patches. (line 27)
* git command, git checkout <11>: Developing new features.
(line 9)
* git command, git pull <6>: Developing new features.
@@ -1960,7 +1967,7 @@ Index
* ownership of directories: General practices. (line 17)
* pager.status configuration setting: Configuring git. (line 24)
* patch, single, generation of: Submitting Changes. (line 14)
-* patches, multiple, generation of: Submitting Changes. (line 24)
+* patches, multiple, generation of: Submitting Changes. (line 29)
* pcc compiler: Compilers. (line 40)
* pcc compiler, Git mirror: Compilers. (line 50)
* Portable C compiler: Compilers. (line 40)
@@ -1994,69 +2001,69 @@ Index

Tag Table:
-Node: Top1162
-Node: Preface5303
-Node: Intended Audience5874
-Node: This Manual6756
-Node: Conventions8317
-Node: Acknowledgments9838
-Node: Reviewers10275
-Node: Contributing10596
-Node: Using Git14050
-Node: Push Pull14810
-Node: Repo Copies16376
-Ref: savannah-repo17391
-Ref: your-repo18448
-Ref: Repo Copies-Footnote-120167
-Node: Local Branches20224
-Ref: your-repo-222045
-Ref: Local Branches-Footnote-123131
-Node: Branches are state23189
-Node: Repo State23924
-Node: Local State26108
-Node: Remotes26776
-Node: Configuring git28133
-Ref: Configuring git-Footnote-130543
-Node: Development without commit access30714
-Node: Cloning31774
-Ref: Cloning-Footnote-133339
-Node: Switching Branches33406
-Node: Starting A New Branch34040
-Ref: Starting A New Branch-Footnote-136024
-Ref: Starting A New Branch-Footnote-236084
-Node: Undoing a change36166
-Node: Saving Without Committing36790
-Node: Updating38374
-Node: Rebasing38889
-Node: Merge Conflicts39511
-Node: Submitting Changes41788
-Ref: Submitting Changes-Footnote-143972
-Ref: Submitting Changes-Footnote-244011
-Ref: Submitting Changes-Footnote-344047
-Node: Removing Branches44095
-Node: Points to remember44631
-Node: Development with commit access46340
-Node: Initial setup46993
-Node: ssh clone47797
-Node: Developing patches48387
-Node: Developing new features49752
-Node: Developing fixes51664
-Node: General practices52755
-Node: Repo Maintenance57584
-Ref: Repo Maintenance-Footnote-160495
-Node: Development Stuff60631
-Node: Coding style61200
-Ref: Coding style-Footnote-161862
-Node: Doing paperwork61956
-Node: Tools62755
-Node: GNU Tools63345
-Node: Compilers65578
-Ref: Compilers-Footnote-168258
-Node: Debugging68296
-Node: Cheat Sheet69107
-Node: Resources73214
-Node: TODO73799
-Node: Index74021
+Node: Top1168
+Node: Preface5315
+Node: Intended Audience5886
+Node: This Manual6768
+Node: Conventions8329
+Node: Acknowledgments9850
+Node: Reviewers10287
+Node: Contributing10608
+Node: Using Git14062
+Node: Push Pull14822
+Node: Repo Copies16388
+Ref: savannah-repo17403
+Ref: your-repo18460
+Ref: Repo Copies-Footnote-120179
+Node: Local Branches20236
+Ref: your-repo-222057
+Ref: Local Branches-Footnote-123143
+Node: Branches are state23201
+Node: Repo State23936
+Node: Local State26120
+Node: Remotes26788
+Node: Configuring git28145
+Ref: Configuring git-Footnote-130555
+Node: Development without commit access30726
+Node: Cloning31786
+Ref: Cloning-Footnote-133351
+Node: Switching Branches33418
+Node: Starting A New Branch34052
+Ref: Starting A New Branch-Footnote-136036
+Ref: Starting A New Branch-Footnote-236096
+Node: Undoing a change36178
+Node: Saving Without Committing36802
+Node: Updating38386
+Node: Rebasing38901
+Node: Merge Conflicts39523
+Node: Submitting Changes41800
+Ref: Submitting Changes-Footnote-144271
+Ref: Submitting Changes-Footnote-244310
+Ref: Submitting Changes-Footnote-344346
+Node: Removing Branches44394
+Node: Points to remember44930
+Node: Development with commit access46639
+Node: Initial setup47292
+Node: ssh clone48096
+Node: Developing patches48686
+Node: Developing new features50110
+Node: Developing fixes52022
+Node: General practices53113
+Node: Repo Maintenance57946
+Ref: Repo Maintenance-Footnote-160857
+Node: Development Stuff60993
+Node: Coding style61562
+Ref: Coding style-Footnote-162224
+Node: Doing paperwork62318
+Node: Tools63117
+Node: GNU Tools63707
+Node: Compilers65940
+Ref: Compilers-Footnote-168620
+Node: Debugging68658
+Node: Cheat Sheet69469
+Node: Resources73576
+Node: TODO74161
+Node: Index74383

End Tag Table
diff --git a/doc/gawkworkflow.texi b/doc/gawkworkflow.texi
index d455c6d5..2afbb664 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 July, 2022
+@set UPDATE-MONTH March, 2023
@set TITLE Participating in @command{gawk} Development
-@set EDITION 0.74
+@set EDITION 0.75
@iftex
@set DOCUMENT booklet
@@ -144,13 +144,13 @@ Fax: +1-617-542-2652
Email: <email>gnu@@gnu.org</email>
URL: <ulink url="http://www.gnu.org">http://www.gnu.org/</ulink></literallayout>
-<literallayout class="normal">Copyright &copy; 2017, 2018, 2019, 2020, 2022
+<literallayout class="normal">Copyright &copy; 2017, 2018, 2019, 2020, 2022, 2023
Free Software Foundation, Inc.
All Rights Reserved.</literallayout>
@end docbook
@ifnotdocbook
-Copyright @copyright{} 2017, 2018, 2019, 2020, 2022
+Copyright @copyright{} 2017, 2018, 2019, 2020, 2022, 2023
Free Software Foundation, Inc.
@end ifnotdocbook
@sp 2
@@ -1301,6 +1301,12 @@ $ @kbd{git diff master > /tmp/python.diff}
Mail the @file{python.diff} file to the appropriate mailing list
along with a description of what you've changed and why.
+The patch file will likely contain changes to generated files,
+such as @file{awkgram.c} or @file{Makefile.in}. If you are
+comfortable manually editing the patch file to remove those
+changes, do so. If not, then send the file as-is and the
+maintainer will handle it.
+
@cindex @command{git} command @subentry @code{git format-patch}
@cindex generating multiple patches
@cindex patches, multiple, generation of
@@ -1493,6 +1499,7 @@ and/or @file{doc/gawk.1}.
@cindex @command{git} command @subentry @code{git diff}
@item
Use @samp{git diff > mychange.diff} to create a patch file.
+(If you want, remove the diffs for generated files.)
@item
Send it to the mailing list for discussion.
@@ -1644,7 +1651,7 @@ Unless you can convince the maintainer (and the other developers!) otherwise,
you should @emph{always} start branches for new features from @code{master},
and not from the current ``stable'' branch.
-Use @samp{checkout -b feature/@var{feature_name}} to create the initial branch.
+Use @samp{git checkout -b feature/@var{feature_name}} to create the initial branch.
You may then elect to keep it purely local, or to push it up to Savannah for
review, even if the feature is not yet totally ``ready for prime time.''
@end table