Note which settings pertain only to the bootloader... #3038
Conversation
See raspberrypi/firmware#1810: Document the settings which will be ignored if they are specified in any additional file which is included from `config.txt`.
Add notes for `start_file`, `fixup_file`, `start_x`, `start_debug`, `bootcode_delay`, `uart_2ndstage`.
Add notes for `sdram_freq`
Add notes for `gpu_mem`, `gpu_mem_256`, `gpu_mem_512`, `gpu_mem_1024`, `total_mem`.
Repeat of `start_file`/`fixup_file` was not intentional.
Improve phrasing
| @@ -9,6 +9,8 @@ These options specify the firmware files transferred to the VideoCore GPU prior | |||
|
|
|||
| NOTE: Cut-down firmware (`start*cd.elf` and `fixup*cd.dat`) cannot be selected this way - the system will fail to boot. The only way to enable the cut-down firmware is to specify `gpu_mem=16`. The cut-down firmware removes support for cameras, codecs and 3D as well as limiting the initial early-boot framebuffer to 1080p @ 16bpp - although KMS can replace this with up-to 32bpp 4K framebuffer(s) at a later stage as with any firmware. | |||
|
|
|||
| NOTE: `start_file` and `fixup_file` are used by the bootloader, and so are only valid in `config.txt` | |||
There was a problem hiding this comment.
Without any other context, I think these standalone NOTEs saying "only valid in config.txt" would be too confusing, given that they all appear on https://www.raspberrypi.com/documentation/computers/config_txt.html which is titled "The config.txt file".
There was a problem hiding this comment.
I guess a link could be added to the section discussing includes - or does it just need to be made more specific by changing the end of the line to something along the lines of "… and so are not allowed in any additional included configuration file"?
The aim here is to avoid the confusion of including a file with these settings in, and then finding that they've not taken effect! 😅
There was a problem hiding this comment.
I think it likely that anybody who's using config.txt includes will have read the section about config.txt include files, and so will have seen the list of settings that don't work in an included file? I'm reluctant to "pollute" the rest of the config.txt documentation with (potentially confusing) information that's only of benefit to a small proportion of users.
There was a problem hiding this comment.
The page is called "config.txt" makes no sense to add notes like this, adds confusion.
There was a problem hiding this comment.
d6900bb removes the individual NOTEs.
|
|
||
| *Include directives are not supported by the bootcode.bin or EEPROM bootloaders*. | ||
|
|
||
| Settings which are handled by the bootloader and so which will only take effect if they are specified in `config.txt` (rather than any additional included file) are: |
There was a problem hiding this comment.
I'd be happy to keep this bit where you document which settings don't work when used in an included file, as I suspect only a very small proportion of users actually use config.txt includes.
There was a problem hiding this comment.
I think a small note block about include files is okay. NOTES per individual items, not so much.
There was a problem hiding this comment.
I think a small note block about include files is okay. NOTES per individual items, not so much.
d6900bb removes the individual NOTEs.
aallan
added
documentation
waiting for revisions
... as requested at raspberrypi#3038 (comment) Signed-off-by: Stuart Shelton <[email protected]>
… and so will only take effect if specified in
config.txt.See raspberrypi/firmware#1810 for discussion.