diff options
author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-03-20 16:11:02 +0100 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2020-03-21 00:01:29 +0100 |
commit | c44166fe5f38f0559eff1138cca094f3460e2345 (patch) | |
tree | c3febd3655ced76c0a8666ead9d92dead378cc76 /Documentation/security/siphash.rst | |
parent | docs: fix reference to core-api/namespaces.rst (diff) | |
download | linux-c44166fe5f38f0559eff1138cca094f3460e2345.tar.xz linux-c44166fe5f38f0559eff1138cca094f3460e2345.zip |
docs: prevent warnings due to autosectionlabel
Changeset 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
enabled a new feature at Sphinx: it will now generate index for each
document title, plus to each chapter inside it.
There's a drawback, though: one document cannot have two sections
with the same name anymore.
A followup patch will change the logic of autosectionlabel to
avoid most creating references for every single section title,
but still we need to be able to reference the chapters inside
a document.
There are a few places where there are two chapters with the
same name. This patch renames one of the chapters, in order to
avoid symbol conflict within the same document.
PS.: as I don't speach Chinese, I had some help from a friend
(Wen Liu) at the Chinese translation for "publishing patches"
for this document:
Documentation/translations/zh_CN/process/5.Posting.rst
Fixes: 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/2bffb91e4a63d41bf5fae1c23e1e8b3bba0b8806.1584716446.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/security/siphash.rst')
-rw-r--r-- | Documentation/security/siphash.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/security/siphash.rst b/Documentation/security/siphash.rst index 9965821ab333..4eba68cdf0a1 100644 --- a/Documentation/security/siphash.rst +++ b/Documentation/security/siphash.rst @@ -128,8 +128,8 @@ then when you can be absolutely certain that the outputs will never be transmitted out of the kernel. This is only remotely useful over `jhash` as a means of mitigating hashtable flooding denial of service attacks. -Generating a key -================ +Generating a HalfSipHash key +============================ Keys should always be generated from a cryptographically secure source of random numbers, either using get_random_bytes or get_random_once: @@ -139,8 +139,8 @@ get_random_bytes(&key, sizeof(key)); If you're not deriving your key from here, you're doing it wrong. -Using the functions -=================== +Using the HalfSipHash functions +=============================== There are two variants of the function, one that takes a list of integers, and one that takes a buffer:: |