annotate doc/format_config.awk @ 8346:107761be1e75

docs: issue2551398 document enabling native browser number/integer types The original default was to have them enabled. Due to issues with locale (e.g. decimal thousands separator vs comma seperator) this is disabled by default. See issue for details.
author John Rouillard <rouilj@ieee.org>
date Wed, 25 Jun 2025 23:10:56 -0400
parents c3bf229d3d4b
children 20943bf4f1b7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1 #! /bin/awk
8274
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
2 BEGIN {SECRET_KEY = "DWmbKgVUy6fF5D2Y5TD5Az+dnHhMYKCCpJzIY3H8nsU="}
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
3
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
4 # delete first 8 lines
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
5 NR < 9 {next}
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
6
8274
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
7 # To prevent new file generation from causing the secret_key to
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
8 # change, we replace the secret key with a fixed value.
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
9 /^# Default: [0-9A-z+=]{44}/ {sub(/[0-9A-z+=]{44}/, SECRET_KEY)}
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
10 /^secret_key = [0-9A-z+=]{44}/ {sub(/[0-9A-z+=]{44}/, SECRET_KEY)}
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
11
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
12 # When we see a section [label]:
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
13 # emit section index marker,
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
14 # emit section anchor
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
15 # set up for code formating
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
16 # emit any comments/blank line that are accumulated before the
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
17 # section marker
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
18 # print the indented section marker
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
19 #
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
20 # zero the accumulator and the variable that prevents large blocks
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
21 # of empty lines.
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
22 /^\[([a-z]*)\]/ { match($0, /^\[([a-z]*)\].*/, section_match);
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
23 section = section_match[1];
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
24 print("\n\n.. index:: config.ini; sections " section);
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
25 print(".. _`config-ini-section-" section "`:");
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
26 print(".. code:: ini\n");
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
27 if (accumulate) {
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
28 print(" " accumulate "\n");
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
29 }
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
30 print(" " $0);
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
31 accumulate = "";
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
32 prev_line_is_blank = 0;
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
33 }
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
34
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
35 # if the line is a setting line (even if commented out)
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
36 # print the accumulated comments/blank lines and the setting line
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
37 # zero the accumulator and the variable that prevents blocks of blank lines
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
38 # get the next input line
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
39 /^#?[a-z0-9_-]* =/ { print accumulate "\n " $0;
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
40 accumulate = "";
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
41 prev_line_is_blank = 0;
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
42 next;
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
43 }
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
44
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
45 # accumulate comment lines and indent them
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
46 /^#/ { accumulate = accumulate "\n " $0; prev_line_is_blank = 0;}
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
47
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
48 # accumulate a blank line only if the previous line was not blank.
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
49 /^$/ { if (! prev_line_is_blank) {accumulate = accumulate $0};
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
50 prev_line_is_blank = 1;
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
51 }
8274
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
52

Roundup Issue Tracker: http://roundup-tracker.org/