lkml.org 
[lkml]   [2020]   [Apr]   [30]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 33/37] docs: networking: convert tc-actions-env-rules.txt to ReST
    Date
    - add SPDX header;
    - add a document title;
    - use the right numbered list markup;
    - adjust identation, whitespaces and blank lines where needed;
    - add to networking/index.rst.

    Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
    ---
    Documentation/networking/index.rst | 1 +
    .../networking/tc-actions-env-rules.rst | 29 +++++++++++++++++++
    .../networking/tc-actions-env-rules.txt | 24 ---------------
    3 files changed, 30 insertions(+), 24 deletions(-)
    create mode 100644 Documentation/networking/tc-actions-env-rules.rst
    delete mode 100644 Documentation/networking/tc-actions-env-rules.txt

    diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
    index 5e495804f96f..f53d89b5679a 100644
    --- a/Documentation/networking/index.rst
    +++ b/Documentation/networking/index.rst
    @@ -106,6 +106,7 @@ Contents:
    skfp
    strparser
    switchdev
    + tc-actions-env-rules

    .. only:: subproject and html

    diff --git a/Documentation/networking/tc-actions-env-rules.rst b/Documentation/networking/tc-actions-env-rules.rst
    new file mode 100644
    index 000000000000..86884b8fb4e0
    --- /dev/null
    +++ b/Documentation/networking/tc-actions-env-rules.rst
    @@ -0,0 +1,29 @@
    +.. SPDX-License-Identifier: GPL-2.0
    +
    +================================
    +TC Actions - Environmental Rules
    +================================
    +
    +
    +The "environmental" rules for authors of any new tc actions are:
    +
    +1) If you stealeth or borroweth any packet thou shalt be branching
    + from the righteous path and thou shalt cloneth.
    +
    + For example if your action queues a packet to be processed later,
    + or intentionally branches by redirecting a packet, then you need to
    + clone the packet.
    +
    +2) If you munge any packet thou shalt call pskb_expand_head in the case
    + someone else is referencing the skb. After that you "own" the skb.
    +
    +3) Dropping packets you don't own is a no-no. You simply return
    + TC_ACT_SHOT to the caller and they will drop it.
    +
    +The "environmental" rules for callers of actions (qdiscs etc) are:
    +
    +#) Thou art responsible for freeing anything returned as being
    + TC_ACT_SHOT/STOLEN/QUEUED. If none of TC_ACT_SHOT/STOLEN/QUEUED is
    + returned, then all is great and you don't need to do anything.
    +
    +Post on netdev if something is unclear.
    diff --git a/Documentation/networking/tc-actions-env-rules.txt b/Documentation/networking/tc-actions-env-rules.txt
    deleted file mode 100644
    index f37814693ad3..000000000000
    --- a/Documentation/networking/tc-actions-env-rules.txt
    +++ /dev/null
    @@ -1,24 +0,0 @@
    -
    -The "environmental" rules for authors of any new tc actions are:
    -
    -1) If you stealeth or borroweth any packet thou shalt be branching
    -from the righteous path and thou shalt cloneth.
    -
    -For example if your action queues a packet to be processed later,
    -or intentionally branches by redirecting a packet, then you need to
    -clone the packet.
    -
    -2) If you munge any packet thou shalt call pskb_expand_head in the case
    -someone else is referencing the skb. After that you "own" the skb.
    -
    -3) Dropping packets you don't own is a no-no. You simply return
    -TC_ACT_SHOT to the caller and they will drop it.
    -
    -The "environmental" rules for callers of actions (qdiscs etc) are:
    -
    -*) Thou art responsible for freeing anything returned as being
    -TC_ACT_SHOT/STOLEN/QUEUED. If none of TC_ACT_SHOT/STOLEN/QUEUED is
    -returned, then all is great and you don't need to do anything.
    -
    -Post on netdev if something is unclear.
    -
    --
    2.25.4
    \
     
     \ /
      Last update: 2020-04-30 18:10    [W:4.035 / U:0.112 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site