summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArnold D. Robbins <arnold@skeeve.com>2022-11-17 17:30:29 +0200
committerArnold D. Robbins <arnold@skeeve.com>2022-11-17 17:30:29 +0200
commit3ce7ef9963911471f122ea5db2be4e56b9d1787e (patch)
tree66fdb7d0ac43be2f67c37004b4dfaec7df0db0cc
parentce0379a151fc871797f00c3e0161af7c702b4ea1 (diff)
downloadgawk-3ce7ef9963911471f122ea5db2be4e56b9d1787e.tar.gz
Doc updates.
-rw-r--r--doc/ChangeLog6
-rw-r--r--doc/gawk.info484
-rw-r--r--doc/gawk.texi4
-rw-r--r--doc/gawktexi.in4
-rw-r--r--doc/pm-gawk.17
5 files changed, 264 insertions, 241 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 510e82ca..20da3b43 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,9 @@
+2022-11-17 Arnold D. Robbins <arnold@skeeve.com>
+
+ * gawktexi.in (Persistent Memory): Document that the CIFS filesystem
+ doesn't work for backing files.
+ * pm-gawk.1: Ditto.
+
2022-11-14 Arnold D. Robbins <arnold@skeeve.com>
* gawktexi.in: Typo fix.
diff --git a/doc/gawk.info b/doc/gawk.info
index 4fb894f4..91e95499 100644
--- a/doc/gawk.info
+++ b/doc/gawk.info
@@ -22245,6 +22245,10 @@ the different verbosity levels are.
'gawk' does not currently detect such a situation and may not do so
in the future either.
+ Additionally, the GNU/Linux CIFS filesystem is known to not work
+ well with the PMA allocator. Don't use a backing file on a CIFS
+ filesystem.
+
Terence Kelly has provided a separate 'Persistent-Memory 'gawk' User
Manual' document, which is included in the 'gawk' distribution. It is
worth reading. *Note General Introduction: (pm-gawk)Top.
@@ -37827,7 +37831,7 @@ Index
* Kahrs, Jürgen <1>: Contributors. (line 71)
* Kasal, Stepan: Acknowledgments. (line 60)
* Kelly, Terence: Persistent Memory. (line 71)
-* Kelly, Terence <1>: Persistent Memory. (line 113)
+* Kelly, Terence <1>: Persistent Memory. (line 117)
* Kelly, Terence <2>: Feature History. (line 508)
* Kenobi, Obi-Wan: Undocumented. (line 6)
* Kernighan, Brian: History. (line 17)
@@ -39623,245 +39627,245 @@ Ref: Two-way I/O-Footnote-2885014
Node: TCP/IP Networking885096
Node: Profiling888172
Node: Persistent Memory897478
-Ref: Persistent Memory-Footnote-1905626
-Ref: Persistent Memory-Footnote-2905765
-Node: Extension Philosophy905892
-Node: Advanced Features Summary907379
-Node: Internationalization909551
-Node: I18N and L10N911225
-Node: Explaining gettext911912
-Ref: Explaining gettext-Footnote-1917804
-Ref: Explaining gettext-Footnote-2917989
-Node: Programmer i18n918154
-Ref: Programmer i18n-Footnote-1923103
-Node: Translator i18n923152
-Node: String Extraction923946
-Ref: String Extraction-Footnote-1925078
-Node: Printf Ordering925164
-Ref: Printf Ordering-Footnote-1927950
-Node: I18N Portability928014
-Ref: I18N Portability-Footnote-1930470
-Node: I18N Example930533
-Ref: I18N Example-Footnote-1933808
-Ref: I18N Example-Footnote-2933881
-Node: Gawk I18N933990
-Node: I18N Summary934612
-Node: Debugger935953
-Node: Debugging936953
-Node: Debugging Concepts937394
-Node: Debugging Terms939203
-Node: Awk Debugging941778
-Ref: Awk Debugging-Footnote-1942723
-Node: Sample Debugging Session942855
-Node: Debugger Invocation943389
-Node: Finding The Bug944775
-Node: List of Debugger Commands951249
-Node: Breakpoint Control952582
-Node: Debugger Execution Control956276
-Node: Viewing And Changing Data959638
-Node: Execution Stack963179
-Node: Debugger Info964816
-Node: Miscellaneous Debugger Commands968887
-Node: Readline Support973949
-Node: Limitations974845
-Node: Debugging Summary977399
-Node: Namespaces978678
-Node: Global Namespace979789
-Node: Qualified Names981187
-Node: Default Namespace982186
-Node: Changing The Namespace982927
-Node: Naming Rules984541
-Node: Internal Name Management986389
-Node: Namespace Example987431
-Node: Namespace And Features989993
-Node: Namespace Summary991428
-Node: Arbitrary Precision Arithmetic992905
-Node: Computer Arithmetic994392
-Ref: table-numeric-ranges998158
-Ref: table-floating-point-ranges998652
-Ref: Computer Arithmetic-Footnote-1999311
-Node: Math Definitions999368
-Ref: table-ieee-formats1002344
-Node: MPFR features1002912
-Node: MPFR On Parole1003357
-Ref: MPFR On Parole-Footnote-11004186
-Node: MPFR Intro1004341
-Node: FP Math Caution1005992
-Ref: FP Math Caution-Footnote-11007064
-Node: Inexactness of computations1007433
-Node: Inexact representation1008464
-Node: Comparing FP Values1009824
-Node: Errors accumulate1011065
-Node: Strange values1012521
-Ref: Strange values-Footnote-11015109
-Node: Getting Accuracy1015214
-Node: Try To Round1017924
-Node: Setting precision1018823
-Ref: table-predefined-precision-strings1019520
-Node: Setting the rounding mode1021351
-Ref: table-gawk-rounding-modes1021725
-Ref: Setting the rounding mode-Footnote-11025657
-Node: Arbitrary Precision Integers1025836
-Ref: Arbitrary Precision Integers-Footnote-11029011
-Node: Checking for MPFR1029160
-Node: POSIX Floating Point Problems1030634
-Ref: POSIX Floating Point Problems-Footnote-11035287
-Node: Floating point summary1035325
-Node: Dynamic Extensions1037515
-Node: Extension Intro1039068
-Node: Plugin License1040334
-Node: Extension Mechanism Outline1041131
-Ref: figure-load-extension1041570
-Ref: figure-register-new-function1043136
-Ref: figure-call-new-function1044229
-Node: Extension API Description1046292
-Node: Extension API Functions Introduction1048005
-Ref: table-api-std-headers1049841
-Node: General Data Types1054091
-Ref: General Data Types-Footnote-11062797
-Node: Memory Allocation Functions1063096
-Ref: Memory Allocation Functions-Footnote-11067597
-Node: Constructor Functions1067696
-Node: API Ownership of MPFR and GMP Values1071349
-Node: Registration Functions1072882
-Node: Extension Functions1073582
-Node: Exit Callback Functions1078904
-Node: Extension Version String1080154
-Node: Input Parsers1080817
-Node: Output Wrappers1093538
-Node: Two-way processors1098050
-Node: Printing Messages1100315
-Ref: Printing Messages-Footnote-11101486
-Node: Updating ERRNO1101639
-Node: Requesting Values1102378
-Ref: table-value-types-returned1103115
-Node: Accessing Parameters1104224
-Node: Symbol Table Access1105461
-Node: Symbol table by name1105973
-Ref: Symbol table by name-Footnote-11108998
-Node: Symbol table by cookie1109126
-Ref: Symbol table by cookie-Footnote-11113311
-Node: Cached values1113375
-Ref: Cached values-Footnote-11116911
-Node: Array Manipulation1117064
-Ref: Array Manipulation-Footnote-11118155
-Node: Array Data Types1118192
-Ref: Array Data Types-Footnote-11120850
-Node: Array Functions1120942
-Node: Flattening Arrays1125727
-Node: Creating Arrays1132703
-Node: Redirection API1137470
-Node: Extension API Variables1140303
-Node: Extension Versioning1141014
-Ref: gawk-api-version1141443
-Node: Extension GMP/MPFR Versioning1143175
-Node: Extension API Informational Variables1144803
-Node: Extension API Boilerplate1145876
-Node: Changes from API V11149850
-Node: Finding Extensions1151422
-Node: Extension Example1151981
-Node: Internal File Description1152779
-Node: Internal File Ops1156859
-Ref: Internal File Ops-Footnote-11168209
-Node: Using Internal File Ops1168349
-Ref: Using Internal File Ops-Footnote-11170732
-Node: Extension Samples1171006
-Node: Extension Sample File Functions1172535
-Node: Extension Sample Fnmatch1180184
-Node: Extension Sample Fork1181671
-Node: Extension Sample Inplace1182889
-Node: Extension Sample Ord1186515
-Node: Extension Sample Readdir1187351
-Ref: table-readdir-file-types1188240
-Node: Extension Sample Revout1189308
-Node: Extension Sample Rev2way1189897
-Node: Extension Sample Read write array1190637
-Node: Extension Sample Readfile1193823
-Node: Extension Sample Time1194918
-Node: Extension Sample API Tests1196670
-Node: gawkextlib1197162
-Node: Extension summary1200080
-Node: Extension Exercises1203782
-Node: Language History1205024
-Node: V7/SVR3.11206680
-Node: SVR41208832
-Node: POSIX1210266
-Node: BTL1211647
-Node: POSIX/GNU1212376
-Node: Feature History1218293
-Node: Common Extensions1236032
-Node: Ranges and Locales1237315
-Ref: Ranges and Locales-Footnote-11241931
-Ref: Ranges and Locales-Footnote-21241958
-Ref: Ranges and Locales-Footnote-31242193
-Node: Contributors1242416
-Node: History summary1248413
-Node: Installation1249793
-Node: Gawk Distribution1250737
-Node: Getting1251221
-Node: Extracting1252184
-Node: Distribution contents1253822
-Node: Unix Installation1261320
-Node: Quick Installation1262124
-Node: Compiling with MPFR1264544
-Node: Shell Startup Files1265234
-Node: Additional Configuration Options1266323
-Node: Configuration Philosophy1268638
-Node: Compiling from Git1271034
-Node: Building the Documentation1271589
-Node: Non-Unix Installation1272973
-Node: PC Installation1273437
-Node: PC Binary Installation1274282
-Node: PC Compiling1275155
-Node: PC Using1276261
-Node: Cygwin1279757
-Node: MSYS1280981
-Node: OpenVMS Installation1281583
-Node: OpenVMS Compilation1282246
-Ref: OpenVMS Compilation-Footnote-11283669
-Node: OpenVMS Dynamic Extensions1283727
-Node: OpenVMS Installation Details1285339
-Node: OpenVMS Running1287634
-Node: OpenVMS GNV1291635
-Node: Bugs1292378
-Node: Bug definition1293290
-Node: Bug address1296792
-Node: Usenet1300311
-Node: Performance bugs1301500
-Node: Asking for help1304421
-Node: Maintainers1306388
-Node: Other Versions1307395
-Node: Installation summary1315974
-Node: Notes1317314
-Node: Compatibility Mode1318108
-Node: Additions1318890
-Node: Accessing The Source1319815
-Node: Adding Code1321252
-Node: New Ports1328067
-Node: Derived Files1332442
-Ref: Derived Files-Footnote-11338101
-Ref: Derived Files-Footnote-21338136
-Ref: Derived Files-Footnote-31338731
-Node: Future Extensions1338845
-Node: Implementation Limitations1339503
-Node: Extension Design1340713
-Node: Old Extension Problems1341857
-Ref: Old Extension Problems-Footnote-11343375
-Node: Extension New Mechanism Goals1343432
-Ref: Extension New Mechanism Goals-Footnote-11346796
-Node: Extension Other Design Decisions1346985
-Node: Extension Future Growth1349098
-Node: Notes summary1349704
-Node: Basic Concepts1350862
-Node: Basic High Level1351543
-Ref: figure-general-flow1351825
-Ref: figure-process-flow1352511
-Ref: Basic High Level-Footnote-11355813
-Node: Basic Data Typing1355998
-Node: Glossary1359326
-Node: Copying1391213
-Node: GNU Free Documentation License1428756
-Node: Index1453876
+Ref: Persistent Memory-Footnote-1905784
+Ref: Persistent Memory-Footnote-2905923
+Node: Extension Philosophy906050
+Node: Advanced Features Summary907537
+Node: Internationalization909709
+Node: I18N and L10N911383
+Node: Explaining gettext912070
+Ref: Explaining gettext-Footnote-1917962
+Ref: Explaining gettext-Footnote-2918147
+Node: Programmer i18n918312
+Ref: Programmer i18n-Footnote-1923261
+Node: Translator i18n923310
+Node: String Extraction924104
+Ref: String Extraction-Footnote-1925236
+Node: Printf Ordering925322
+Ref: Printf Ordering-Footnote-1928108
+Node: I18N Portability928172
+Ref: I18N Portability-Footnote-1930628
+Node: I18N Example930691
+Ref: I18N Example-Footnote-1933966
+Ref: I18N Example-Footnote-2934039
+Node: Gawk I18N934148
+Node: I18N Summary934770
+Node: Debugger936111
+Node: Debugging937111
+Node: Debugging Concepts937552
+Node: Debugging Terms939361
+Node: Awk Debugging941936
+Ref: Awk Debugging-Footnote-1942881
+Node: Sample Debugging Session943013
+Node: Debugger Invocation943547
+Node: Finding The Bug944933
+Node: List of Debugger Commands951407
+Node: Breakpoint Control952740
+Node: Debugger Execution Control956434
+Node: Viewing And Changing Data959796
+Node: Execution Stack963337
+Node: Debugger Info964974
+Node: Miscellaneous Debugger Commands969045
+Node: Readline Support974107
+Node: Limitations975003
+Node: Debugging Summary977557
+Node: Namespaces978836
+Node: Global Namespace979947
+Node: Qualified Names981345
+Node: Default Namespace982344
+Node: Changing The Namespace983085
+Node: Naming Rules984699
+Node: Internal Name Management986547
+Node: Namespace Example987589
+Node: Namespace And Features990151
+Node: Namespace Summary991586
+Node: Arbitrary Precision Arithmetic993063
+Node: Computer Arithmetic994550
+Ref: table-numeric-ranges998316
+Ref: table-floating-point-ranges998810
+Ref: Computer Arithmetic-Footnote-1999469
+Node: Math Definitions999526
+Ref: table-ieee-formats1002502
+Node: MPFR features1003070
+Node: MPFR On Parole1003515
+Ref: MPFR On Parole-Footnote-11004344
+Node: MPFR Intro1004499
+Node: FP Math Caution1006150
+Ref: FP Math Caution-Footnote-11007222
+Node: Inexactness of computations1007591
+Node: Inexact representation1008622
+Node: Comparing FP Values1009982
+Node: Errors accumulate1011223
+Node: Strange values1012679
+Ref: Strange values-Footnote-11015267
+Node: Getting Accuracy1015372
+Node: Try To Round1018082
+Node: Setting precision1018981
+Ref: table-predefined-precision-strings1019678
+Node: Setting the rounding mode1021509
+Ref: table-gawk-rounding-modes1021883
+Ref: Setting the rounding mode-Footnote-11025815
+Node: Arbitrary Precision Integers1025994
+Ref: Arbitrary Precision Integers-Footnote-11029169
+Node: Checking for MPFR1029318
+Node: POSIX Floating Point Problems1030792
+Ref: POSIX Floating Point Problems-Footnote-11035445
+Node: Floating point summary1035483
+Node: Dynamic Extensions1037673
+Node: Extension Intro1039226
+Node: Plugin License1040492
+Node: Extension Mechanism Outline1041289
+Ref: figure-load-extension1041728
+Ref: figure-register-new-function1043294
+Ref: figure-call-new-function1044387
+Node: Extension API Description1046450
+Node: Extension API Functions Introduction1048163
+Ref: table-api-std-headers1049999
+Node: General Data Types1054249
+Ref: General Data Types-Footnote-11062955
+Node: Memory Allocation Functions1063254
+Ref: Memory Allocation Functions-Footnote-11067755
+Node: Constructor Functions1067854
+Node: API Ownership of MPFR and GMP Values1071507
+Node: Registration Functions1073040
+Node: Extension Functions1073740
+Node: Exit Callback Functions1079062
+Node: Extension Version String1080312
+Node: Input Parsers1080975
+Node: Output Wrappers1093696
+Node: Two-way processors1098208
+Node: Printing Messages1100473
+Ref: Printing Messages-Footnote-11101644
+Node: Updating ERRNO1101797
+Node: Requesting Values1102536
+Ref: table-value-types-returned1103273
+Node: Accessing Parameters1104382
+Node: Symbol Table Access1105619
+Node: Symbol table by name1106131
+Ref: Symbol table by name-Footnote-11109156
+Node: Symbol table by cookie1109284
+Ref: Symbol table by cookie-Footnote-11113469
+Node: Cached values1113533
+Ref: Cached values-Footnote-11117069
+Node: Array Manipulation1117222
+Ref: Array Manipulation-Footnote-11118313
+Node: Array Data Types1118350
+Ref: Array Data Types-Footnote-11121008
+Node: Array Functions1121100
+Node: Flattening Arrays1125885
+Node: Creating Arrays1132861
+Node: Redirection API1137628
+Node: Extension API Variables1140461
+Node: Extension Versioning1141172
+Ref: gawk-api-version1141601
+Node: Extension GMP/MPFR Versioning1143333
+Node: Extension API Informational Variables1144961
+Node: Extension API Boilerplate1146034
+Node: Changes from API V11150008
+Node: Finding Extensions1151580
+Node: Extension Example1152139
+Node: Internal File Description1152937
+Node: Internal File Ops1157017
+Ref: Internal File Ops-Footnote-11168367
+Node: Using Internal File Ops1168507
+Ref: Using Internal File Ops-Footnote-11170890
+Node: Extension Samples1171164
+Node: Extension Sample File Functions1172693
+Node: Extension Sample Fnmatch1180342
+Node: Extension Sample Fork1181829
+Node: Extension Sample Inplace1183047
+Node: Extension Sample Ord1186673
+Node: Extension Sample Readdir1187509
+Ref: table-readdir-file-types1188398
+Node: Extension Sample Revout1189466
+Node: Extension Sample Rev2way1190055
+Node: Extension Sample Read write array1190795
+Node: Extension Sample Readfile1193981
+Node: Extension Sample Time1195076
+Node: Extension Sample API Tests1196828
+Node: gawkextlib1197320
+Node: Extension summary1200238
+Node: Extension Exercises1203940
+Node: Language History1205182
+Node: V7/SVR3.11206838
+Node: SVR41208990
+Node: POSIX1210424
+Node: BTL1211805
+Node: POSIX/GNU1212534
+Node: Feature History1218451
+Node: Common Extensions1236190
+Node: Ranges and Locales1237473
+Ref: Ranges and Locales-Footnote-11242089
+Ref: Ranges and Locales-Footnote-21242116
+Ref: Ranges and Locales-Footnote-31242351
+Node: Contributors1242574
+Node: History summary1248571
+Node: Installation1249951
+Node: Gawk Distribution1250895
+Node: Getting1251379
+Node: Extracting1252342
+Node: Distribution contents1253980
+Node: Unix Installation1261478
+Node: Quick Installation1262282
+Node: Compiling with MPFR1264702
+Node: Shell Startup Files1265392
+Node: Additional Configuration Options1266481
+Node: Configuration Philosophy1268796
+Node: Compiling from Git1271192
+Node: Building the Documentation1271747
+Node: Non-Unix Installation1273131
+Node: PC Installation1273595
+Node: PC Binary Installation1274440
+Node: PC Compiling1275313
+Node: PC Using1276419
+Node: Cygwin1279915
+Node: MSYS1281139
+Node: OpenVMS Installation1281741
+Node: OpenVMS Compilation1282404
+Ref: OpenVMS Compilation-Footnote-11283827
+Node: OpenVMS Dynamic Extensions1283885
+Node: OpenVMS Installation Details1285497
+Node: OpenVMS Running1287792
+Node: OpenVMS GNV1291793
+Node: Bugs1292536
+Node: Bug definition1293448
+Node: Bug address1296950
+Node: Usenet1300469
+Node: Performance bugs1301658
+Node: Asking for help1304579
+Node: Maintainers1306546
+Node: Other Versions1307553
+Node: Installation summary1316132
+Node: Notes1317472
+Node: Compatibility Mode1318266
+Node: Additions1319048
+Node: Accessing The Source1319973
+Node: Adding Code1321410
+Node: New Ports1328225
+Node: Derived Files1332600
+Ref: Derived Files-Footnote-11338259
+Ref: Derived Files-Footnote-21338294
+Ref: Derived Files-Footnote-31338889
+Node: Future Extensions1339003
+Node: Implementation Limitations1339661
+Node: Extension Design1340871
+Node: Old Extension Problems1342015
+Ref: Old Extension Problems-Footnote-11343533
+Node: Extension New Mechanism Goals1343590
+Ref: Extension New Mechanism Goals-Footnote-11346954
+Node: Extension Other Design Decisions1347143
+Node: Extension Future Growth1349256
+Node: Notes summary1349862
+Node: Basic Concepts1351020
+Node: Basic High Level1351701
+Ref: figure-general-flow1351983
+Ref: figure-process-flow1352669
+Ref: Basic High Level-Footnote-11355971
+Node: Basic Data Typing1356156
+Node: Glossary1359484
+Node: Copying1391371
+Node: GNU Free Documentation License1428914
+Node: Index1454034

End Tag Table
diff --git a/doc/gawk.texi b/doc/gawk.texi
index 8535232e..04b78b4c 100644
--- a/doc/gawk.texi
+++ b/doc/gawk.texi
@@ -31182,6 +31182,10 @@ Mixing and matching MPFR mode and regular mode with the same
backing file will lead to strange results and/or core dumps.
@command{gawk} does not currently detect such a situation and
may not do so in the future either.
+
+Additionally, the GNU/Linux CIFS filesystem is known to not
+work well with the PMA allocator.
+Don't use a backing file on a CIFS filesystem.
@end quotation
Terence Kelly has provided a separate @cite{@value{PMGAWKTITLE}}
diff --git a/doc/gawktexi.in b/doc/gawktexi.in
index 11b073b5..63936675 100644
--- a/doc/gawktexi.in
+++ b/doc/gawktexi.in
@@ -30064,6 +30064,10 @@ Mixing and matching MPFR mode and regular mode with the same
backing file will lead to strange results and/or core dumps.
@command{gawk} does not currently detect such a situation and
may not do so in the future either.
+
+Additionally, the GNU/Linux CIFS filesystem is known to not
+work well with the PMA allocator.
+Don't use a backing file on a CIFS filesystem.
@end quotation
Terence Kelly has provided a separate @cite{@value{PMGAWKTITLE}}
diff --git a/doc/pm-gawk.1 b/doc/pm-gawk.1
index c3f4c0eb..9f87d89b 100644
--- a/doc/pm-gawk.1
+++ b/doc/pm-gawk.1
@@ -1,6 +1,6 @@
.ds EP \fIGAWK: Effective AWK Programming\fP
.ds PM \fIPersistent Memory gawk User Manual\fP
-.TH PM-GAWK 1 "Aug 14 2022" "Free Software Foundation" "Utility Commands"
+.TH PM-GAWK 1 "Nov 17 2022" "Free Software Foundation" "Utility Commands"
.SH NAME
persistent memory gawk \- persistent data and functions
.SH SYNOPSIS
@@ -156,6 +156,11 @@ was developed by Haris Volos, Zi Fan
Tan, and Jianan Li using a fork of the official
.I gawk
sources.
+.SH CAVEATS
+The GNU/Linux CIFS filesystem is known to cause problems
+for the persistent memory allocator. Do not use a backing file
+on such a filesystem with
+.IR pm-gawk .
.SH BUG REPORTS
Follow the procedures in \*(EP and in \*(PM.
For suspected