mirror of https://github.com/aljazceru/lightning.git synced 2025-12-24 01:24:26 +01:00

Files

Matt Whitlock 09d52b3cb4 doc: escape more naughty underscores

The only time underscores aren't special in Markdown is when they appear
in preformatted text. We have gotten away with not escaping underscores
where an asterisk-enclosed span or the paragraph ends before the next
underscore appears, but this is fragile and bad practice. Conversely,
there are many places where we have not escaped underscores but needed
to.

Escape all underscores that do not appear in preformatted blocks or
preformatted spans and are not themselves delineating emphasized spans.

The changes in this commit are exactly the result of executing the
following Bash code:

```bash
e=':x;'           	# begin loop
e+='s/^'          	# anchor match at beginning of line
e+='('            	# begin capturing subexpression
	e+='('    	# begin list of alternatives
		e+='[^`_\\]|'        	# any mundane character, or
		e+='`([^`\\]|\\.)*`|'	# backtick-enclosed span, or
		e+='\b_|_\b|'        	# underscore at boundary, or
		e+='\\.'             	# backslash-escaped character
	e+=')*'   	# any number of the preceding alternatives
e+=')'            	# end capturing subexpression
e+='\B_\B/\1\\_/;'	# escape non-formatting underscore
e+='tx'           	# repeat loop if we escaped an underscore

escape_underscores=(
	sed

	# use extended regular expressions
	-E

	# skip over indented blocks (following an empty line)
	-e '/^$/{:i;n;/^( {4,}|\t)/bi}'

	# skip over preformatted blocks
	-e '/^\s*```/,/^\s*```/{p;d}'

	# skip over generated sections
	-e '/GENERATE-FROM-SCHEMA-START/,/GENERATE-FROM-SCHEMA-END/{p;d}'

	# escape underscores
	-e "${e}"
)

"${escape_underscores[@]}" -i doc/*.[0-9].md
```

Changelog-None

2022-12-12 15:34:00 +10:30

997 B

Raw Blame History

lightning-makesecret -- Command for deriving pseudorandom key from HSM

SYNOPSIS

makesecret [hex] [string]

DESCRIPTION

The makesecret RPC command derives a secret key from the HSM_secret.

One of hex or string must be specified: hex can be any hex data, string is a UTF-8 string interpreted literally.

RETURN VALUE

On success, an object is returned, containing:

secret (secret): the pseudorandom key derived from HSM_secret (always 64 characters)

The following error codes may occur:

-1: Catchall nonspecific error.

AUTHOR

Aditya <aditya.sharma20111@gmail.com> is mainly responsible.

RESOURCES

Main web site: https://github.com/ElementsProject/lightning

997 B Raw Blame History