Skip to content

Commit aea09bf

Browse files
committed
Review request: RFC text formatting
Signed-off-by: mrgarris0n <gergely.karacsonyi@gmail.com>
1 parent 62b6a43 commit aea09bf

File tree

9 files changed

+21
-18
lines changed

9 files changed

+21
-18
lines changed

_data/external_links.yml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -430,25 +430,30 @@ welf:
430430

431431
### RFC links ###
432432

433+
rfc-3164:
434+
id: rfc-3164
435+
url: https://www.ietf.org/rfc/rfc3164.txt
436+
title: [ "RFC-3164" ]
437+
433438
rfc-3526:
434439
id: rfc-3526
435440
url: https://www.ietf.org/rfc/rfc3526.txt
436-
title: [ "RFC 3526" ]
441+
title: [ "RFC-3526" ]
437442

438443
rfc-4180:
439444
id: rfc-4180
440445
url: https://tools.ietf.org/html/rfc4180
441-
title: [ "RFC4180 CSV format" ]
446+
title: [ "RFC-4180 CSV format" ]
442447

443448
rfc-4627:
444449
id: rfc-4627
445450
url: https://tools.ietf.org/html/rfc4627
446-
title: [ "RFC 4627" ]
451+
title: [ "RFC-4627" ]
447452

448453
rfc-5424:
449454
id: rfc-5424
450455
url: https://tools.ietf.org/html/rfc5424#page-8
451-
title: [ "RFC 5424-compliant form" ]
456+
title: [ "RFC-5424" ]
452457

453458
rfc-base64:
454459
id: rfc-base64
@@ -468,7 +473,7 @@ rfc-ietf-syslog-proto:
468473
rfc-octet:
469474
id: rfc-octet
470475
url: https://tools.ietf.org/html/rfc6587#section-3.4.1
471-
title: [ "the octet counting method described in RFC6587" ]
476+
title: [ "the octet counting method described in RFC-6587" ]
472477

473478
rfc-sdid:
474479
id: rfc-sdid

doc/_admin-guide/020_The_concepts_of_syslog-ng/007_The_structure_of_a_log_message/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ description: >-
77

88
Currently there are two standard syslog message formats:
99

10-
- The old standard described in RFC 3164 (also called the BSD-syslog
10+
- The old standard described in RFC-3164 (also called the BSD-syslog
1111
or the legacy-syslog protocol): see
1212
BSD-syslog or legacy-syslog messages.
1313

14-
- The new standard described in RFC 5424 (also called the IETF-syslog
14+
- The new standard described in RFC-5424 (also called the IETF-syslog
1515
protocol): see IETF-syslog messages.
1616

1717
- The Enterprise-wide message model or EWMM allows you to deliver

doc/_admin-guide/060_Sources/170_Syslog/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ BSD-syslog or legacy-syslog messages
1515
if they are sent using the IETF-syslog protocol.
1616

1717
In syslog-ng OSE versions 3.1 and earlier, the syslog() driver could
18-
handle only messages in the IETF-syslog (RFC 5424-26) format.
18+
handle only messages in the IETF-syslog (RFC-5424) format.
1919

2020
For the list of available optional parameters, see
2121
syslog() source options.

doc/_admin-guide/070_Destinations/290_Sumologic/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ destinations with syslog-ng OSE has the following limitations:
7777

7878
- The minimum required version of syslog-ng OSE is version 3.27.1.
7979

80-
- Message format must be in RFC 5424-compliant form. Messages over
80+
- Message format must be in RFC-5424 compliant form. Messages over
8181
64KB in length are truncated.
8282

8383
For more information about the message format limitations, see the
@@ -86,10 +86,8 @@ destinations with syslog-ng OSE has the following limitations:
8686
- 64 characters long Sumo Logic tokens must be passed in the message
8787
body.
8888

89-
NOTE: Although RFC 5424
90-
limits the structured data field
91-
(SD-ID) to 32
92-
characters, Sumo Logic tokens are 64 characters long. If your
89+
NOTE: Although RFC-5424 limits the structured data field
90+
(SD-ID) to 32 characters, Sumo Logic tokens are 64 characters long. If your
9391
logging client enforces the 32 characters length limit, you must
9492
pass the token in the message body.
9593

doc/_admin-guide/100_TLS-encrypted_message_transfer/004_TLS_options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ of the files must be .r0.
5757
generated using the openssl dhparam utility. Note that syslog-ng OSE
5858
supports only DH parameter files in the PEM format. If you do not set
5959
this parameter, syslog-ng OSE uses the 2048-bit MODP Group, as
60-
described in RFC 3526.
60+
described in RFC-3526.
6161

6262
## ecdh-curve-list()
6363

doc/_admin-guide/120_Parser/003_JSON_parser/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: >-
77
JavaScript Object Notation (JSON) is a text-based open standard designed
88
for human-readable data interchange. It is used primarily to transmit
99
data between a server and web application, serving as an alternative to
10-
XML. It is described in RFC 4627.
10+
XML. It is described in RFC-4627.
1111
The syslog-ng OSE application can separate parts of incoming
1212
JSON-encoded log messages to name-value pairs. For details on using
1313
value-pairs in syslog-ng OSE see

doc/_admin-guide/120_Parser/004_XML_parser/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ any of the following options:
133133

134134
- In the case of TCP, you can encapsulate and send the document in
135135
syslog-protocol format, and use a syslog() source. Make sure
136-
that the message conforms to the octet counting method described in RFC6587.
136+
that the message conforms to the octet counting method described in RFC-6587.
137137

138138
For example:
139139

doc/_admin-guide/140_Enriching_log_messages_with_external_data/000_Adding_metadata_from_external_file/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ the IP address, and adds the host-role field to the log message.
3838

3939
## The database file
4040

41-
The database file must comply with the RFC4180 CSV format,
41+
The database file must comply with the RFC-4180 CSV format,
4242
with the following exceptions and limitations:
4343

4444
- The values of the CSV-file cannot contain line-breaks

doc/_admin-guide/200_About/002_Glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ A name that identifies a host on the network.
146146
### IETF-syslog protocol
147147

148148
The syslog-protocol standard developed by the Internet Engineering Task
149-
Force (IETF), described in RFC 5424-5427.
149+
Force (IETF), described in RFC-5424.
150150

151151
## K
152152

0 commit comments

Comments
 (0)