Re: [PATCH] Documentation: fix reST markup error in driver-api/usb/typec.rst
On Sun, Apr 08, 2018 at 10:47:12AM +0800, changbin...@intel.com wrote: > From: Changbin Du > > There is an format error in driver-api/usb/typec.rst that breaks sphinx > docs building. > > reST markup error: > /home/changbin/work/linux/Documentation/driver-api/usb/typec.rst:215: > (SEVERE/4) Unexpected section title or transition. > > > Documentation/Makefile:68: recipe for target 'htmldocs' failed > make[1]: *** [htmldocs] Error 1 > Makefile:1527: recipe for target 'htmldocs' failed > make: *** [htmldocs] Error 2 > > Signed-off-by: Changbin Du > --- > Documentation/driver-api/usb/typec.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) Thanks, someone else already sent this, sorry. I'll be sending it onward after 4.17-rc1 is out. greg k-h -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH] Documentation: fix reST markup error in driver-api/usb/typec.rst
On Sun, Apr 08, 2018 at 09:19:58AM +0200, Greg KH wrote: > On Sun, Apr 08, 2018 at 10:47:12AM +0800, changbin...@intel.com wrote: > > From: Changbin Du > > > > There is an format error in driver-api/usb/typec.rst that breaks sphinx > > docs building. > > > > reST markup error: > > /home/changbin/work/linux/Documentation/driver-api/usb/typec.rst:215: > > (SEVERE/4) Unexpected section title or transition. > > > > > > Documentation/Makefile:68: recipe for target 'htmldocs' failed > > make[1]: *** [htmldocs] Error 1 > > Makefile:1527: recipe for target 'htmldocs' failed > > make: *** [htmldocs] Error 2 > > > > Signed-off-by: Changbin Du > > --- > > Documentation/driver-api/usb/typec.rst | 2 +- > > 1 file changed, 1 insertion(+), 1 deletion(-) > > Thanks, someone else already sent this, sorry. I'll be sending it > onward after 4.17-rc1 is out. > No problem. Thanks for your quick checking! > greg k-h -- Thanks, Changbin Du -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
[RFC PATCH v2 1/6] Documentation/features: Add script that refreshes the arch support status files in place
Provides the script:
Documentation/features/scripts/features-refresh.sh
which operates on the arch-support.txt files and refreshes them in place.
This way [1],
"[...] we soft- decouple the refreshing of the entries from the
introduction of the features, while still making it all easy to
keep sync and to extend."
[1] https://marc.info/?l=linux-kernel&m=152240950509781&w=2
Suggested-by: Ingo Molnar
Signed-off-by: Andrea Parri
Cc: Ingo Molnar
Cc: Jonathan Corbet
Cc: Andrew Morton
---
Documentation/features/scripts/features-refresh.sh | 98 ++
1 file changed, 98 insertions(+)
create mode 100755 Documentation/features/scripts/features-refresh.sh
diff --git a/Documentation/features/scripts/features-refresh.sh
b/Documentation/features/scripts/features-refresh.sh
new file mode 100755
index 0..9e72d38a0720e
--- /dev/null
+++ b/Documentation/features/scripts/features-refresh.sh
@@ -0,0 +1,98 @@
+#
+# Small script that refreshes the kernel feature support status in place.
+#
+
+for F_FILE in Documentation/features/*/*/arch-support.txt; do
+ F=$(grep "^# Kconfig:" "$F_FILE" | cut -c26-)
+
+ #
+ # Each feature F is identified by a pair (O, K), where 'O' can
+ # be either the empty string (for 'nop') or "not" (the logical
+ # negation operator '!'); other operators are not supported.
+ #
+ O=""
+ K=$F
+ if [[ "$F" == !* ]]; then
+ O="not"
+ K=$(echo $F | sed -e 's/^!//g')
+ fi
+
+ #
+ # F := (O, K) is 'valid' iff there is a Kconfig file (for some
+ # arch) which contains K.
+ #
+ # Notice that this definition entails an 'asymmetry' between
+ # the case 'O = ""' and the case 'O = "not"'. E.g., F may be
+ # _invalid_ if:
+ #
+ # [case 'O = ""']
+ # 1) no arch provides support for F,
+ # 2) K does not exist (e.g., it was renamed/mis-typed);
+ #
+ # [case 'O = "not"']
+ # 3) all archs provide support for F,
+ # 4) as in (2).
+ #
+ # The rationale for adopting this definition (and, thus, for
+ # keeping the asymmetry) is:
+ #
+ # We want to be able to 'detect' (2) (or (4)).
+ #
+ # (1) and (3) may further warn the developers about the fact
+ # that K can be removed.
+ #
+ F_VALID="false"
+ for ARCH_DIR in arch/*/; do
+ K_FILES=$(find $ARCH_DIR -name "Kconfig*")
+ K_GREP=$(grep "$K" $K_FILES)
+ if [ ! -z "$K_GREP" ]; then
+ F_VALID="true"
+ break
+ fi
+ done
+ if [ "$F_VALID" = "false" ]; then
+ printf "WARNING: '%s' is not a valid Kconfig\n" "$F"
+ fi
+
+ T_FILE="$F_FILE.tmp"
+ grep "^#" $F_FILE > $T_FILE
+ echo "---" >> $T_FILE
+ echo "| arch |status|" >> $T_FILE
+ echo "---" >> $T_FILE
+ for ARCH_DIR in arch/*/; do
+ ARCH=$(echo $ARCH_DIR | sed -e 's/arch//g' | sed -e 's/\///g')
+ K_FILES=$(find $ARCH_DIR -name "Kconfig*")
+ K_GREP=$(grep "$K" $K_FILES)
+ #
+ # Arch support status values for (O, K) are updated according
+ # to the following rules.
+ #
+ # - ("", K) is 'supported by a given arch', if there is a
+ # Kconfig file for that arch which contains K;
+ #
+ # - ("not", K) is 'supported by a given arch', if there is
+ # no Kconfig file for that arch which contains K;
+ #
+ # - otherwise: preserve the previous status value (if any),
+ #default to 'not yet supported'.
+ #
+ # Notice that, according these rules, invalid features may be
+ # updated/modified.
+ #
+ if [ "$O" = "" ] && [ ! -z "$K_GREP" ]; then
+ printf "|%12s: | ok |\n" "$ARCH" >> $T_FILE
+ elif [ "$O" = "not" ] && [ -z "$K_GREP" ]; then
+ printf "|%12s: | ok |\n" "$ARCH" >> $T_FILE
+ else
+ S=$(grep -v "^#" "$F_FILE" | grep " $ARCH:")
+ if [ ! -z "$S" ]; then
+ echo "$S" >> $T_FILE
+ else
+ printf "|%12s: | TODO |\n" "$ARCH" \
+ >> $T_FILE
+ fi
+ fi
+ done
+ echo "---" >> $T_FILE
+ mv $T_FILE $F_FILE
+done
--
2.7.4
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.ke
[RFC PATCH v2 6/6] Documentation/features/vm: Remove arch support status file for 'pte_special'
Suggested-by: Ingo Molnar Signed-off-by: Andrea Parri Cc: Ingo Molnar Cc: Jonathan Corbet Cc: Andrew Morton --- .../features/vm/pte_special/arch-support.txt | 33 -- 1 file changed, 33 deletions(-) delete mode 100644 Documentation/features/vm/pte_special/arch-support.txt diff --git a/Documentation/features/vm/pte_special/arch-support.txt b/Documentation/features/vm/pte_special/arch-support.txt deleted file mode 100644 index 6a608a6dcf71d..0 --- a/Documentation/features/vm/pte_special/arch-support.txt +++ /dev/null @@ -1,33 +0,0 @@ -# -# Feature name: pte_special -# Kconfig: __HAVE_ARCH_PTE_SPECIAL -# description: arch supports the pte_special()/pte_mkspecial() VM APIs -# ---- -| arch |status| ---- -| alpha: | TODO | -| arc: | ok | -| arm: | ok | -| arm64: | ok | -| c6x: | TODO | -| h8300: | TODO | -| hexagon: | TODO | -|ia64: | TODO | -|m68k: | TODO | -| microblaze: | TODO | -|mips: | TODO | -| nds32: | TODO | -| nios2: | TODO | -|openrisc: | TODO | -| parisc: | TODO | -| powerpc: | ok | -| riscv: | TODO | -|s390: | ok | -| sh: | ok | -| sparc: | ok | -| um: | TODO | -| unicore32: | TODO | -| x86: | ok | -| xtensa: | TODO | ---- -- 2.7.4 -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
[RFC PATCH v2 0/6] Documentation/features: Provide and apply 'features-refresh.sh'
Hi, This series provides the script 'features-refresh.sh', which operates on the arch support status files, and it applies this script to refresh the status files in place; previous discussions about this series are at [1]. The series is organized as follows. - Patch 1/6 adds the script to 'Documentation/features/scripts/'. - Patch 2/6 presents the results of running the script; this run also printed the messages WARNING: 'HAVE_BPF_JIT' is not a valid Kconfig WARNING: '__HAVE_ARCH_STRNCASECMP' is not a valid Kconfig WARNING: 'Optimized asm/rwsem.h' is not a valid Kconfig WARNING: '__HAVE_ARCH_PTE_SPECIAL' is not a valid Kconfig to standard output. - Patches 3-6/6 fix each of these warnings. (Applies on today's mainline.) Cheers, Andrea [1] https://marc.info/?l=linux-kernel&m=152223974927255&w=2 https://marc.info/?l=linux-kernel&m=152277458614862&w=2 Changes in v2: - support negation operators in Kconfig (suggested by Ingo Molnar) - reorder patches 2/6 and 3/6 (suggested by Ingo Molnar) - add patches 4-6/6 (suggested by Ingo Molnar) Andrea Parri (6): Documentation/features: Add script that refreshes the arch support status files in place Documentation/features: Refresh the arch support status files in place Documentation/features/core: Add arch support status files for 'cBPF-JIT' and 'eBPF-JIT' Documentation/features/locking: Use '!RWSEM_GENERIC_SPINLOCK' as Kconfig for 'rwsem-optimized' Documentation/features/lib: Remove arch support status file for 'strncasecmp' Documentation/features/vm: Remove arch support status file for 'pte_special' .../features/core/BPF-JIT/arch-support.txt | 31 --- .../features/core/cBPF-JIT/arch-support.txt| 33 .../features/core/eBPF-JIT/arch-support.txt| 33 .../core/generic-idle-thread/arch-support.txt | 4 +- .../features/core/jump-labels/arch-support.txt | 2 + .../features/core/tracehook/arch-support.txt | 2 + .../features/debug/KASAN/arch-support.txt | 4 +- .../debug/gcov-profile-all/arch-support.txt| 2 + Documentation/features/debug/kgdb/arch-support.txt | 4 +- .../debug/kprobes-on-ftrace/arch-support.txt | 2 + .../features/debug/kprobes/arch-support.txt| 4 +- .../features/debug/kretprobes/arch-support.txt | 4 +- .../features/debug/optprobes/arch-support.txt | 4 +- .../features/debug/stackprotector/arch-support.txt | 2 + .../features/debug/uprobes/arch-support.txt| 6 +- .../debug/user-ret-profiler/arch-support.txt | 2 + .../features/io/dma-api-debug/arch-support.txt | 2 + .../features/io/dma-contiguous/arch-support.txt| 4 +- .../features/io/sg-chain/arch-support.txt | 2 + .../features/lib/strncasecmp/arch-support.txt | 31 --- .../locking/cmpxchg-local/arch-support.txt | 4 +- .../features/locking/lockdep/arch-support.txt | 4 +- .../locking/queued-rwlocks/arch-support.txt| 10 ++- .../locking/queued-spinlocks/arch-support.txt | 8 +- .../locking/rwsem-optimized/arch-support.txt | 10 ++- .../features/perf/kprobes-event/arch-support.txt | 6 +- .../features/perf/perf-regs/arch-support.txt | 4 +- .../features/perf/perf-stackdump/arch-support.txt | 4 +- .../sched/membarrier-sync-core/arch-support.txt| 2 + .../features/sched/numa-balancing/arch-support.txt | 6 +- Documentation/features/scripts/features-refresh.sh | 98 ++ .../seccomp/seccomp-filter/arch-support.txt| 6 +- .../time/arch-tick-broadcast/arch-support.txt | 4 +- .../features/time/clockevents/arch-support.txt | 4 +- .../time/context-tracking/arch-support.txt | 2 + .../features/time/irq-time-acct/arch-support.txt | 4 +- .../time/modern-timekeeping/arch-support.txt | 2 + .../features/time/virt-cpuacct/arch-support.txt| 2 + .../features/vm/ELF-ASLR/arch-support.txt | 4 +- .../features/vm/PG_uncached/arch-support.txt | 2 + Documentation/features/vm/THP/arch-support.txt | 2 + Documentation/features/vm/TLB/arch-support.txt | 2 + .../features/vm/huge-vmap/arch-support.txt | 2 + .../features/vm/ioremap_prot/arch-support.txt | 2 + .../features/vm/numa-memblock/arch-support.txt | 4 +- .../features/vm/pte_special/arch-support.txt | 31 --- 46 files changed, 279 insertions(+), 128 deletions(-) delete mode 100644 Documentation/features/core/BPF-JIT/arch-support.txt create mode 100644 Documentation/features/core/cBPF-JIT/arch-support.txt create mode 100644 Documentation/features/core/eBPF-JIT/arch-support.txt delete mode 100644 Documentation/features/lib/strncasecmp/arch-support.txt create mode 100755 Documentation/features/scripts/features-refresh.sh delete mode 100644 Documentation/features/vm/pte_special/arch-support.txt -- 2.7.4 -- To unsubscribe from this list:
[RFC PATCH v2 5/6] Documentation/features/lib: Remove arch support status file for 'strncasecmp'
Suggested-by: Ingo Molnar Signed-off-by: Andrea Parri Cc: Ingo Molnar Cc: Jonathan Corbet Cc: Andrew Morton --- .../features/lib/strncasecmp/arch-support.txt | 33 -- 1 file changed, 33 deletions(-) delete mode 100644 Documentation/features/lib/strncasecmp/arch-support.txt diff --git a/Documentation/features/lib/strncasecmp/arch-support.txt b/Documentation/features/lib/strncasecmp/arch-support.txt deleted file mode 100644 index 6148f42c3d902..0 --- a/Documentation/features/lib/strncasecmp/arch-support.txt +++ /dev/null @@ -1,33 +0,0 @@ -# -# Feature name: strncasecmp -# Kconfig: __HAVE_ARCH_STRNCASECMP -# description: arch provides an optimized strncasecmp() function -# ---- -| arch |status| ---- -| alpha: | TODO | -| arc: | TODO | -| arm: | TODO | -| arm64: | TODO | -| c6x: | TODO | -| h8300: | TODO | -| hexagon: | TODO | -|ia64: | TODO | -|m68k: | TODO | -| microblaze: | TODO | -|mips: | TODO | -| nds32: | TODO | -| nios2: | TODO | -|openrisc: | TODO | -| parisc: | TODO | -| powerpc: | TODO | -| riscv: | TODO | -|s390: | TODO | -| sh: | TODO | -| sparc: | TODO | -| um: | TODO | -| unicore32: | TODO | -| x86: | TODO | -| xtensa: | TODO | ---- -- 2.7.4 -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
[RFC PATCH v2 4/6] Documentation/features/locking: Use '!RWSEM_GENERIC_SPINLOCK' as Kconfig for 'rwsem-optimized'
Uses '!RWSEM_GENERIC_SPINLOCK' in place of 'Optimized asm/rwsem.h' as Kconfig for 'rwsem-optimized': the new Kconfig expresses this feature equivalently, while also enabling the script 'features-refresh.sh' to operate on the corresponding arch support status file. Also refreshes the status matrix by using the script 'features-refresh.sh'. Suggested-by: Ingo Molnar Signed-off-by: Andrea Parri Cc: Ingo Molnar Cc: Jonathan Corbet Cc: Andrew Morton --- Documentation/features/locking/rwsem-optimized/arch-support.txt | 8 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/features/locking/rwsem-optimized/arch-support.txt b/Documentation/features/locking/rwsem-optimized/arch-support.txt index 8afe24ffa3ab4..e54b1f1a8091d 100644 --- a/Documentation/features/locking/rwsem-optimized/arch-support.txt +++ b/Documentation/features/locking/rwsem-optimized/arch-support.txt @@ -1,6 +1,6 @@ # # Feature name: rwsem-optimized -# Kconfig: Optimized asm/rwsem.h +# Kconfig: !RWSEM_GENERIC_SPINLOCK # description: arch provides optimized rwsem APIs # --- @@ -8,8 +8,8 @@ --- | alpha: | ok | | arc: | TODO | -| arm: | TODO | -| arm64: | TODO | +| arm: | ok | +| arm64: | ok | | c6x: | TODO | | h8300: | TODO | | hexagon: | TODO | @@ -26,7 +26,7 @@ |s390: | ok | | sh: | ok | | sparc: | ok | -| um: | TODO | +| um: | ok | | unicore32: | TODO | | x86: | ok | | xtensa: | ok | -- 2.7.4 -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
[RFC PATCH v2 2/6] Documentation/features: Refresh the arch support status files in place
Now that the script 'features-refresh.sh' is available, uses this script to refresh all the arch-support.txt files in place. Signed-off-by: Andrea Parri Cc: Ingo Molnar Cc: Jonathan Corbet Cc: Andrew Morton --- Documentation/features/core/BPF-JIT/arch-support.txt | 2 ++ .../features/core/generic-idle-thread/arch-support.txt | 4 +++- Documentation/features/core/jump-labels/arch-support.txt | 2 ++ Documentation/features/core/tracehook/arch-support.txt | 2 ++ Documentation/features/debug/KASAN/arch-support.txt| 4 +++- Documentation/features/debug/gcov-profile-all/arch-support.txt | 2 ++ Documentation/features/debug/kgdb/arch-support.txt | 4 +++- .../features/debug/kprobes-on-ftrace/arch-support.txt | 2 ++ Documentation/features/debug/kprobes/arch-support.txt | 4 +++- Documentation/features/debug/kretprobes/arch-support.txt | 4 +++- Documentation/features/debug/optprobes/arch-support.txt| 4 +++- Documentation/features/debug/stackprotector/arch-support.txt | 2 ++ Documentation/features/debug/uprobes/arch-support.txt | 6 -- .../features/debug/user-ret-profiler/arch-support.txt | 2 ++ Documentation/features/io/dma-api-debug/arch-support.txt | 2 ++ Documentation/features/io/dma-contiguous/arch-support.txt | 4 +++- Documentation/features/io/sg-chain/arch-support.txt| 2 ++ Documentation/features/lib/strncasecmp/arch-support.txt| 2 ++ Documentation/features/locking/cmpxchg-local/arch-support.txt | 4 +++- Documentation/features/locking/lockdep/arch-support.txt| 4 +++- Documentation/features/locking/queued-rwlocks/arch-support.txt | 10 ++ .../features/locking/queued-spinlocks/arch-support.txt | 8 +--- .../features/locking/rwsem-optimized/arch-support.txt | 2 ++ Documentation/features/perf/kprobes-event/arch-support.txt | 6 -- Documentation/features/perf/perf-regs/arch-support.txt | 4 +++- Documentation/features/perf/perf-stackdump/arch-support.txt| 4 +++- .../features/sched/membarrier-sync-core/arch-support.txt | 2 ++ Documentation/features/sched/numa-balancing/arch-support.txt | 6 -- Documentation/features/seccomp/seccomp-filter/arch-support.txt | 6 -- .../features/time/arch-tick-broadcast/arch-support.txt | 4 +++- Documentation/features/time/clockevents/arch-support.txt | 4 +++- Documentation/features/time/context-tracking/arch-support.txt | 2 ++ Documentation/features/time/irq-time-acct/arch-support.txt | 4 +++- .../features/time/modern-timekeeping/arch-support.txt | 2 ++ Documentation/features/time/virt-cpuacct/arch-support.txt | 2 ++ Documentation/features/vm/ELF-ASLR/arch-support.txt| 4 +++- Documentation/features/vm/PG_uncached/arch-support.txt | 2 ++ Documentation/features/vm/THP/arch-support.txt | 2 ++ Documentation/features/vm/TLB/arch-support.txt | 2 ++ Documentation/features/vm/huge-vmap/arch-support.txt | 2 ++ Documentation/features/vm/ioremap_prot/arch-support.txt| 2 ++ Documentation/features/vm/numa-memblock/arch-support.txt | 4 +++- Documentation/features/vm/pte_special/arch-support.txt | 2 ++ 43 files changed, 117 insertions(+), 31 deletions(-) diff --git a/Documentation/features/core/BPF-JIT/arch-support.txt b/Documentation/features/core/BPF-JIT/arch-support.txt index 0b96b4e1e7d4a..d277f971ccd6b 100644 --- a/Documentation/features/core/BPF-JIT/arch-support.txt +++ b/Documentation/features/core/BPF-JIT/arch-support.txt @@ -17,10 +17,12 @@ |m68k: | TODO | | microblaze: | TODO | |mips: | ok | +| nds32: | TODO | | nios2: | TODO | |openrisc: | TODO | | parisc: | TODO | | powerpc: | ok | +| riscv: | TODO | |s390: | ok | | sh: | TODO | | sparc: | ok | diff --git a/Documentation/features/core/generic-idle-thread/arch-support.txt b/Documentation/features/core/generic-idle-thread/arch-support.txt index 372a2b18a6172..0ef6acdb991c7 100644 --- a/Documentation/features/core/generic-idle-thread/arch-support.txt +++ b/Documentation/features/core/generic-idle-thread/arch-support.txt @@ -17,10 +17,12 @@ |m68k: | TODO | | microblaze: | TODO | |mips: | ok | +| nds32: | TODO | | nios2: | TODO | -|openrisc: | TODO | +|openrisc: | ok | | parisc: | ok | | powerpc: | ok | +| riscv: | ok | |s390: | ok | | sh: | ok | | sparc: | ok | diff --git a/Documentation/features/core/jump-labels/arch-support.txt b/Documentation/features/core/jump-labels/arch-support.txt index ad97217b003ba..27cbd63abfd28 100644 --- a/Documentation/f
[RFC PATCH v2 3/6] Documentation/features/core: Add arch support status files for 'cBPF-JIT' and 'eBPF-JIT'
Commit 606b5908e split 'HAVE_BPF_JIT' into cBPF and eBPF variant. Adds arch support status files for the new variants, and removes the status file corresponding to 'HAVE_BPT_JIT'. The new status matrices were auto-generated using the script 'features-refresh.sh'. Signed-off-by: Andrea Parri Cc: Ingo Molnar Cc: Jonathan Corbet Cc: Andrew Morton --- .../features/core/BPF-JIT/arch-support.txt | 33 -- .../features/core/cBPF-JIT/arch-support.txt| 33 ++ .../features/core/eBPF-JIT/arch-support.txt| 33 ++ 3 files changed, 66 insertions(+), 33 deletions(-) delete mode 100644 Documentation/features/core/BPF-JIT/arch-support.txt create mode 100644 Documentation/features/core/cBPF-JIT/arch-support.txt create mode 100644 Documentation/features/core/eBPF-JIT/arch-support.txt diff --git a/Documentation/features/core/BPF-JIT/arch-support.txt b/Documentation/features/core/BPF-JIT/arch-support.txt deleted file mode 100644 index d277f971ccd6b..0 --- a/Documentation/features/core/BPF-JIT/arch-support.txt +++ /dev/null @@ -1,33 +0,0 @@ -# -# Feature name: BPF-JIT -# Kconfig: HAVE_BPF_JIT -# description: arch supports BPF JIT optimizations -# ---- -| arch |status| ---- -| alpha: | TODO | -| arc: | TODO | -| arm: | ok | -| arm64: | ok | -| c6x: | TODO | -| h8300: | TODO | -| hexagon: | TODO | -|ia64: | TODO | -|m68k: | TODO | -| microblaze: | TODO | -|mips: | ok | -| nds32: | TODO | -| nios2: | TODO | -|openrisc: | TODO | -| parisc: | TODO | -| powerpc: | ok | -| riscv: | TODO | -|s390: | ok | -| sh: | TODO | -| sparc: | ok | -| um: | TODO | -| unicore32: | TODO | -| x86: | ok | -| xtensa: | TODO | ---- diff --git a/Documentation/features/core/cBPF-JIT/arch-support.txt b/Documentation/features/core/cBPF-JIT/arch-support.txt new file mode 100644 index 0..90459cdde3143 --- /dev/null +++ b/Documentation/features/core/cBPF-JIT/arch-support.txt @@ -0,0 +1,33 @@ +# +# Feature name: cBPF-JIT +# Kconfig: HAVE_CBPF_JIT +# description: arch supports cBPF JIT optimizations +# +--- +| arch |status| +--- +| alpha: | TODO | +| arc: | TODO | +| arm: | TODO | +| arm64: | TODO | +| c6x: | TODO | +| h8300: | TODO | +| hexagon: | TODO | +|ia64: | TODO | +|m68k: | TODO | +| microblaze: | TODO | +|mips: | ok | +| nds32: | TODO | +| nios2: | TODO | +|openrisc: | TODO | +| parisc: | TODO | +| powerpc: | ok | +| riscv: | TODO | +|s390: | TODO | +| sh: | TODO | +| sparc: | ok | +| um: | TODO | +| unicore32: | TODO | +| x86: | TODO | +| xtensa: | TODO | +--- diff --git a/Documentation/features/core/eBPF-JIT/arch-support.txt b/Documentation/features/core/eBPF-JIT/arch-support.txt new file mode 100644 index 0..c90a0382fe667 --- /dev/null +++ b/Documentation/features/core/eBPF-JIT/arch-support.txt @@ -0,0 +1,33 @@ +# +# Feature name: eBPF-JIT +# Kconfig: HAVE_EBPF_JIT +# description: arch supports eBPF JIT optimizations +# +--- +| arch |status| +--- +| alpha: | TODO | +| arc: | TODO | +| arm: | ok | +| arm64: | ok | +| c6x: | TODO | +| h8300: | TODO | +| hexagon: | TODO | +|ia64: | TODO | +|m68k: | TODO | +| microblaze: | TODO | +|mips: | ok | +| nds32: | TODO | +| nios2: | TODO | +|openrisc: | TODO | +| parisc: | TODO | +| powerpc: | ok | +| riscv: | TODO | +|s390: | ok | +| sh: | TODO | +| sparc: | ok | +| um: | TODO | +| unicore32: | TODO | +| x86: | ok | +| xtensa: | TODO | +--- -- 2.7.4 -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH] Fixed typo in onewire generic doc
Hi everyone I'm really sorry for that long delay. Was this patch accepted or should I push it upstream? 20.12.2017, 22:09, "Gergo Huszty" : > Onewire devices has 6 byte long unique serial numbers, 1 byte family > code and 1 byte CRC. Linux sysfs presents the device folder in the > form of familyID-deviceID, so CRC is not shown. The consequence is > that the device serial number is always a 12 long hex-string, but > doc says 13 in one place. This is corrected by this change. > Reference: https://en.wikipedia.org/wiki/1-Wire > > Signed-off-by: Gergo Huszty > --- > Documentation/w1/w1.generic | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/w1/w1.generic b/Documentation/w1/w1.generic > index b3ffaf8cfab2..c51b1ab012d0 100644 > --- a/Documentation/w1/w1.generic > +++ b/Documentation/w1/w1.generic > @@ -76,7 +76,7 @@ See struct w1_bus_master definition in w1.h for details. > > w1 master sysfs interface > -- > - - A directory for a found device. The format is > family-serial > + - A directory for a found device. The format is > family-serial > bus - (standard) symlink to the w1 bus > driver - (standard) symlink to the w1 driver > w1_master_add - (rw) manually register a slave device > -- > 2.15.1 -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [RFC bpf-next] bpf: document eBPF helpers and add a script to generate man page
On Fri, Apr 06, 2018 at 12:11:22PM +0100, Quentin Monnet wrote:
> eBPF helper functions can be called from within eBPF programs to perform
> a variety of tasks that would be otherwise hard or impossible to do with
> eBPF itself. There is a growing number of such helper functions in the
> kernel, but documentation is scarce. The main user space header file
> does contain a short commented description of most helpers, but it is
> somewhat outdated and not complete. It is more a "cheat sheet" than a
> real documentation accessible to new eBPF developers.
>
> This commit attempts to improve the situation by replacing the existing
> overview for the helpers with a more developed description. Furthermore,
> a Python script is added to generate a manual page for eBPF helpers. The
> workflow is the following, and requires the rst2man utility:
>
> $ ./scripts/bpf_helpers_doc.py \
> --filename include/uapi/linux/bpf.h > /tmp/bpf-helpers.rst
> $ rst2man /tmp/bpf-helpers.rst > /tmp/bpf-helpers.7
> $ man /tmp/bpf-helpers.7
>
> The objective is to keep all documentation related to the helpers in a
> single place, and to be able to generate from here a manual page that
> could be packaged in the man-pages repository and shipped with most
> distributions [1].
>
> Additionally, parsing the prototypes of the helper functions could
> hopefully be reused, with a different Printer object, to generate
> header files needed in some eBPF-related projects.
>
> Regarding the description of each helper, it comprises several items:
>
> - The function prototype.
> - A description of the function and of its arguments (except for a
> couple of cases, when there are no arguments and the return value
> makes the function usage really obvious).
> - A description of return values (if not void).
> - A listing of eBPF program types (if relevant, map types) compatible
> with the helper.
> - Information about the helper being restricted to GPL programs, or not.
> - The kernel version in which the helper was introduced.
> - The commit that introduced the helper (this is mostly to have it in
> the source of the man page, as it can be used to track changes and
> update the page).
>
> For several helpers, descriptions are inspired (at times, nearly copied)
> from the commit logs introducing them in the kernel--Many thanks to
> their respective authors! They were completed as much as possible, the
> objective being to have something easily accessible even for people just
> starting with eBPF. There is probably a bit more work to do in this
> direction for some helpers.
>
> Some RST formatting is used in the descriptions (not in function
> prototypes, to keep them readable, but the Python script provided in
> order to generate the RST for the manual page does add formatting to
> prototypes, to produce something pretty) to get "bold" and "italics" in
> manual pages. Hopefully, the descriptions in bpf.h file remains
> perfectly readable. Note that the few trailing white spaces are
> intentional, removing them would break paragraphs for rst2man.
>
> The descriptions should ideally be updated each time someone adds a new
> helper, or updates the behaviour (compatibility extended to new program
> types, new socket option supported...) or the interface (new flags
> available, ...) of existing ones.
>
> [1] I have not contacted people from the man-pages project prior to
> sending this RFC, so I can offer no guaranty at this time that they
> would accept to take the generated man page.
>
> Cc: linux-doc@vger.kernel.org
> Cc: linux-...@vger.kernel.org
> Signed-off-by: Quentin Monnet
> ---
> include/uapi/linux/bpf.h | 2237
>
> scripts/bpf_helpers_doc.py | 568 +++
> 2 files changed, 2429 insertions(+), 376 deletions(-)
> create mode 100755 scripts/bpf_helpers_doc.py
>
> diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h
> index c5ec89732a8d..f47aeddbbe0a 100644
> --- a/include/uapi/linux/bpf.h
> +++ b/include/uapi/linux/bpf.h
> @@ -367,394 +367,1879 @@ union bpf_attr {
>
> /* BPF helper function descriptions:
> *
> - * void *bpf_map_lookup_elem(&map, &key)
> - * Return: Map value or NULL
> - *
> - * int bpf_map_update_elem(&map, &key, &value, flags)
> - * Return: 0 on success or negative error
> - *
> - * int bpf_map_delete_elem(&map, &key)
> - * Return: 0 on success or negative error
> - *
> - * int bpf_probe_read(void *dst, int size, void *src)
> - * Return: 0 on success or negative error
> + * void *bpf_map_lookup_elem(struct bpf_map *map, void *key)
> + * Description
> + * Perform a lookup in *map* for an entry associated to *key*.
> + * Return
> + * Map value associated to *key*, or **NULL** if no entry was
> + * found.
> + * For
> + * All types of programs. Limited to maps of types
> + * **BPF_MAP_TYPE_HASH**,
> + * **BPF_MAP_TYPE_ARRAY**,
>
Re: [PATCH V2 3/9] dt-bindings: Tegra186 tachometer device tree bindings
Rob, this binding is for a specific IP block (for measuring/aggregating input pulses) on the Tegra186 SoC, so I don't think it fits into any generic binding. Thanks, Mikko On 03/27/2018 05:52 PM, Rob Herring wrote: On Wed, Mar 21, 2018 at 10:10:38AM +0530, Rajkumar Rampelli wrote: Supply Device tree binding documentation for the NVIDIA Tegra186 SoC's Tachometer Controller Signed-off-by: Rajkumar Rampelli --- V2: Renamed compatible string to "nvidia,tegra186-pwm-tachometer" Renamed dt property values of clock-names and reset-names to "tachometer" from "tach" Read my prior comments on v1. Rob -- To unsubscribe from this list: send the line "unsubscribe linux-tegra" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
