Skip to content
Snippets Groups Projects
  • David Marchand's avatar
    1094dd94
    cleanup compat header inclusions · 1094dd94
    David Marchand authored
    
    With symbols going though experimental/stable stages, we accumulated
    a lot of discrepancies about inclusion of the rte_compat.h header.
    
    Some headers are including it where unneeded, while others rely on
    implicit inclusion.
    
    Fix unneeded inclusions:
    $ git grep -l include..rte_compat.h |
      xargs grep -LE '__rte_(internal|experimental)' |
      xargs sed -i -e '/#include..rte_compat.h/d'
    
    Fix missing inclusion, by inserting rte_compat.h before the first
    inclusion of a DPDK header:
    $ git grep -lE '__rte_(internal|experimental)' |
      xargs grep -L include..rte_compat.h |
      xargs sed -i -e \
        '0,/#include..\(rte_\|.*pmd.h.$\)/{
          s/\(#include..\(rte_\|.*pmd.h.$\)\)/#include <rte_compat.h>\n\1/
        }'
    
    Fix missing inclusion, by inserting rte_compat.h after the last
    inclusion of a non DPDK header:
    $ for file in $(git grep -lE '__rte_(internal|experimental)' |
      xargs grep -L include..rte_compat.h); do
        tac $file > $file.$$
        sed -i -e \
          '0,/#include../{
            s/\(#include..*$\)/#include <rte_compat.h>\n\n\1/
          }' $file.$$
        tac $file.$$ > $file
        rm $file.$$
      done
    
    Fix missing inclusion, by inserting rte_compat.h after the header guard:
    $ git grep -lE '__rte_(internal|experimental)' |
      xargs grep -L include..rte_compat.h |
      xargs sed -i -e \
        '0,/#define/{
          s/\(#define .*$\)/\1\n\n#include <rte_compat.h>/
        }'
    
    And finally, exclude rte_compat.h itself.
    $ git checkout lib/eal/include/rte_compat.h
    
    At the end of all this, we have a clean tree:
    $ git grep -lE '__rte_(internal|experimental)' |
      xargs grep -L include..rte_compat.h
    buildtools/check-symbols.sh
    devtools/checkpatches.sh
    doc/guides/contributing/abi_policy.rst
    doc/guides/rel_notes/release_20_11.rst
    lib/eal/include/rte_compat.h
    
    Signed-off-by: default avatarDavid Marchand <david.marchand@redhat.com>
    Acked-by: default avatarBruce Richardson <bruce.richardson@intel.com>
    Acked-by: default avatarAndrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
    1094dd94
    History
    cleanup compat header inclusions
    David Marchand authored
    
    With symbols going though experimental/stable stages, we accumulated
    a lot of discrepancies about inclusion of the rte_compat.h header.
    
    Some headers are including it where unneeded, while others rely on
    implicit inclusion.
    
    Fix unneeded inclusions:
    $ git grep -l include..rte_compat.h |
      xargs grep -LE '__rte_(internal|experimental)' |
      xargs sed -i -e '/#include..rte_compat.h/d'
    
    Fix missing inclusion, by inserting rte_compat.h before the first
    inclusion of a DPDK header:
    $ git grep -lE '__rte_(internal|experimental)' |
      xargs grep -L include..rte_compat.h |
      xargs sed -i -e \
        '0,/#include..\(rte_\|.*pmd.h.$\)/{
          s/\(#include..\(rte_\|.*pmd.h.$\)\)/#include <rte_compat.h>\n\1/
        }'
    
    Fix missing inclusion, by inserting rte_compat.h after the last
    inclusion of a non DPDK header:
    $ for file in $(git grep -lE '__rte_(internal|experimental)' |
      xargs grep -L include..rte_compat.h); do
        tac $file > $file.$$
        sed -i -e \
          '0,/#include../{
            s/\(#include..*$\)/#include <rte_compat.h>\n\n\1/
          }' $file.$$
        tac $file.$$ > $file
        rm $file.$$
      done
    
    Fix missing inclusion, by inserting rte_compat.h after the header guard:
    $ git grep -lE '__rte_(internal|experimental)' |
      xargs grep -L include..rte_compat.h |
      xargs sed -i -e \
        '0,/#define/{
          s/\(#define .*$\)/\1\n\n#include <rte_compat.h>/
        }'
    
    And finally, exclude rte_compat.h itself.
    $ git checkout lib/eal/include/rte_compat.h
    
    At the end of all this, we have a clean tree:
    $ git grep -lE '__rte_(internal|experimental)' |
      xargs grep -L include..rte_compat.h
    buildtools/check-symbols.sh
    devtools/checkpatches.sh
    doc/guides/contributing/abi_policy.rst
    doc/guides/rel_notes/release_20_11.rst
    lib/eal/include/rte_compat.h
    
    Signed-off-by: default avatarDavid Marchand <david.marchand@redhat.com>
    Acked-by: default avatarBruce Richardson <bruce.richardson@intel.com>
    Acked-by: default avatarAndrew Rybchenko <andrew.rybchenko@oktetlabs.ru>