leandrof/u-boot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

buildman: Convert documentation to rST

Browse Source 
Convert the buildman documentation to rST format and include it in the
'build' section.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Quentin Schulz <foss+uboot@0leil.net>
This commit is contained in:
Simon Glass 2022-11-09 19:14:43 -07:00
parent b38da15a05
commit 74df491051
7 changed files with 1413 additions and 1353 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/build/buildman.rst vendored Symbolic link
View File

@ -0,0 +1 @@
../../tools/buildman/buildman.rst

1
doc/build/index.rst vendored
View File

@ -11,3 +11,4 @@ Build U-Boot
clang clang
docker docker
tools tools
buildman

1349
tools/buildman/README
View File

File diff suppressed because it is too large Load Diff

1
tools/buildman/README.rst Symbolic link
View File

@ -0,0 +1 @@
buildman.rst

1406
tools/buildman/buildman.rst Normal file
View File

File diff suppressed because it is too large Load Diff

4
tools/buildman/control.py
View File

@ -136,8 +136,8 @@ def DoBuildman(options, args, toolchains=None, make_func=None, brds=None,
if options.full_help: if options.full_help:
tools.print_full_help( tools.print_full_help(
os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), 'README') os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
) 'README.rst'))
return 0 return 0
gitutil.setup() gitutil.setup()

4
tools/buildman/func_test.py
View File

@ -249,7 +249,7 @@ class TestFunctional(unittest.TestCase):
def testFullHelp(self): def testFullHelp(self):
command.test_result = None command.test_result = None
result = self._RunBuildman('-H') result = self._RunBuildman('-H')
help_file = os.path.join(self._buildman_dir, 'README') help_file = os.path.join(self._buildman_dir, 'README.rst')
# Remove possible extraneous strings # Remove possible extraneous strings
extra = '::::::::::::::\n' + help_file + '\n::::::::::::::\n' extra = '::::::::::::::\n' + help_file + '\n::::::::::::::\n'
gothelp = result.stdout.replace(extra, '') gothelp = result.stdout.replace(extra, '')
@ -260,7 +260,7 @@ class TestFunctional(unittest.TestCase):
def testHelp(self): def testHelp(self):
command.test_result = None command.test_result = None
result = self._RunBuildman('-h') result = self._RunBuildman('-h')
help_file = os.path.join(self._buildman_dir, 'README') help_file = os.path.join(self._buildman_dir, 'README.rst')
self.assertTrue(len(result.stdout) > 1000) self.assertTrue(len(result.stdout) > 1000)
self.assertEqual(0, len(result.stderr)) self.assertEqual(0, len(result.stderr))
self.assertEqual(0, result.return_code) self.assertEqual(0, result.return_code)