mirror of
https://review.coreboot.org/flashrom.git
synced 2025-04-27 15:12:36 +02:00

Use sphinx (sphinx-doc.org) to generate the UNIX man page from an reStructuredText file instead of dealing with plain groff. Use `meson setup -Dman-pages=enabled` to build the man page, and `meson setup -Ddocumentation=enabled` to build the web documentation explicitly. Both are enabled automatically if sphinx-build is found. The man page will be installed as `<meson_mandir>/man8/flashrom.8` and The html documentation in <meson_datadir>/doc/flashrom/html`. The Makefile builds only the man-page format. Increase the minimum version of meson from 0.53.0 to 0.57.0 to be able to pass environment variables to the custom_target() command. That is needed to pass the FLASHROM_VERSION to the documentation. Change-Id: Iee9f1164c5913e47385e6f7d51dc7775a58b5a67 Signed-off-by: Thomas Heijligen <thomas.heijligen@secunet.com> Reviewed-on: https://review.coreboot.org/c/flashrom/+/72619 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Anastasia Klimchuk <aklm@chromium.org> Reviewed-by: Alexander Goncharov <chat@joursoir.net>
23 lines
1.9 KiB
Meson
23 lines
1.9 KiB
Meson
option('classic_cli', type : 'feature', value : 'enabled', description : 'classic flashrom cli binary')
|
|
option('classic_cli_print_wiki', type : 'feature', value : 'disabled', description : 'Print Wiki')
|
|
option('default_programmer_name', type : 'string', description : 'default programmer')
|
|
option('default_programmer_args', type : 'string', description : 'default programmer arguments')
|
|
option('ich_descriptors_tool', type : 'feature', value : 'auto', description : 'Build ich_descriptors_tool')
|
|
option('bash_completion', type : 'feature', value : 'auto', description : 'Install bash completion')
|
|
option('tests', type : 'feature', value : 'auto', description : 'Build unit tests')
|
|
option('use_internal_dmi', type : 'boolean', value : 'true')
|
|
option('programmer', type : 'array', value : ['auto'], choices : [
|
|
'auto', 'all',
|
|
'group_internal', 'group_external',
|
|
'group_ftdi', 'group_i2c', 'group_jlink', 'group_pci', 'group_serial', 'group_usb',
|
|
'asm106x', 'atahpt', 'atapromise', 'atavia', 'buspirate_spi', 'ch341a_spi', 'ch347_spi','dediprog',
|
|
'developerbox_spi', 'digilent_spi', 'dirtyjtag_spi', 'drkaiser', 'dummy', 'ft2232_spi',
|
|
'gfxnvidia', 'internal', 'it8212', 'jlink_spi', 'linux_mtd', 'linux_spi', 'mediatek_i2c_spi',
|
|
'mstarddc_spi', 'nic3com', 'nicintel', 'nicintel_eeprom', 'nicintel_spi', 'nicnatsemi',
|
|
'nicrealtek', 'ogp_spi', 'parade_lspcon', 'pickit2_spi', 'pony_spi', 'raiden_debug_spi',
|
|
'rayer_spi', 'realtek_mst_i2c_spi', 'satamv', 'satasii', 'serprog', 'stlinkv3_spi', 'usbblaster_spi',
|
|
], description: 'Active programmers')
|
|
option('llvm_cov', type : 'feature', value : 'disabled', description : 'build for llvm code coverage')
|
|
option('man-pages', type : 'feature', value : 'auto', description : 'build the man-page for classic_cli')
|
|
option('documentation', type : 'feature', value : 'auto', description : 'build the html documentation')
|