adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 10

kconfiglib: Fix paths for gsource'd files in the documentation

Browse source 
$srctree was changed to an absolute path when the documentation building
was switched over to CMake, which uncovered a bug in Kconfiglib that
caused symbols in gsource'd files to show up with absolute paths in the
auto-generated Kconfig documentation.

This commit adds upstream commit ac692af07a123 ("Fix absolute $srctree
prefixes showing up on gsource'd files"), which fixes it.

Upstream commit message:

  When using gsource with $srctree set to an absolute path, the $srctree
  prefix would show up in MenuNode.filename, trickling its way into e.g.
  generated documentation.

  This was due to a broken test: os.path.isabs() was checked after
  joining the pattern with $srctree, making it mistake an absolute
  $srctree for an absolute path in the Kconfig file.

  Fix the test.

Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
This commit is contained in:
Ulf Magnusson 2018-07-13 19:09:37 +02:00 committed by Carles Cufí
parent 93ca721c48
commit 953cc12464
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
scripts/kconfig/kconfiglib.py
View file

@ -2178,15 +2178,20 @@ class Kconfig(object):
pattern = os.path.join(os.path.dirname(self._filename), pattern = os.path.join(os.path.dirname(self._filename),
pattern) pattern)
if self.srctree is None:
strip_srctree = False
else:
# $srctree set and pattern not absolute?
strip_srctree = not os.path.isabs(pattern)
# If $srctree is set, glob relative to it # If $srctree is set, glob relative to it
if self.srctree is not None:
pattern = os.path.join(self.srctree, pattern) pattern = os.path.join(self.srctree, pattern)
# Sort the glob results to ensure a consistent ordering of # Sort the glob results to ensure a consistent ordering of
# Kconfig symbols, which indirectly ensures a consistent # Kconfig symbols, which indirectly ensures a consistent
# ordering in e.g. .config files # ordering in e.g. .config files
for filename in sorted(glob.iglob(pattern)): for filename in sorted(glob.iglob(pattern)):
if self.srctree is not None and not os.path.isabs(filename): if strip_srctree:
# Strip the $srctree prefix from the filename and let # Strip the $srctree prefix from the filename and let
# the normal $srctree logic find the file. This makes # the normal $srctree logic find the file. This makes
# the globbed filenames appear without a $srctree # the globbed filenames appear without a $srctree