Docs: Configtxt reformat #540
Conversation
The config.txt docs were getting very long so have split off the file in to subfiles in a sub folder and provided a README to index them. Have also grepped over the whole database and fixed up any links.
|
Note to copy editor - I have not changed any of the actual text, apart from the headings at the top of each subfile. However, that does not mean the original text was ok..... |
|
The reason for the split was that the file was very large, making it difficult determine where changes need to be made. Hopefully splitting off in to sub sections will enable easier future editing. |
|
@JamesH65 Would you like a full copy edit of these documents? I'm happy to do that if it would be helpful! |
|
I suspect this document originated with engineering, and perhaps has never been copy edited. So probably worth giving it a once over. |
Update codeclicence.md
Update audio.md
Update boot.md
Update overclocking.md
|
Just checking that I have seen all the subfolders. Have I missed anything? Is there anything else I need to look at? |
|
I think the split-into-a-subfolder means that all of the relative links to other pages also need to be checked and updated? |
IIRC @ghollingworth did the initial import from the eLinux wiki, and I then did a lot of editing to it when the Raspberry Pi documentation site went live ;-) |
|
I did check the links from other pages before I submitted the PR, but a
second check would be worthwhile.
…On 6 March 2017 at 17:31, Andrew Scheller ***@***.***> wrote:
I suspect this document originated with engineering
IIRC @ghollingworth <https://github.com/ghollingworth> did the initial
import from the eLinux wiki, and I then did a lot of editing to it when the
Raspberry Pi documentation site went live ;-)
(yes, we're both engineers!)
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#540 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ADqrHf3OZpUz60yyR3LkF2LQbSDLU0vjks5rjELfgaJpZM4MSa6g>
.
--
James Hughes
Principal Software Engineer,
Raspberry Pi (Trading) Ltd
|
Moved over Lorna changes from config.txt
|
I've merged Lorna's changes from 53363ad to this branch prior to merging. @LornaLynch Can you check the changes? They are confined to codes and boot files so only those need checking. |
configuration/config-txt/README.md
Outdated
| @@ -0,0 +1,53 @@ | |||
| # config.txt | |||
|
|
|||
| The Raspberry Pi uses an configuration file instead of the [BIOS](https://en.wikipedia.org/wiki/BIOS) you would expect to find on a conventional PC. The system configuration parameters, which would traditionally be edited and stored using a BIOS, are stored instead in an optional text file named `config.txt`. This is read by the GPU before the ARM CPU and Linux are initialised. It must therefore be located on the first (boot) partition of your SD card, alongside `bootcode.bin` and `start.elf`. This file is normally accessible as `/boot/config.txt` from Linux, and must be edited as [root](../linux/usage/root.md). From Windows or OS X it is visible as a file in the only accessible part of the card. If you need to apply some of the config settings below, but you don't have a `config.txt` on your boot partition yet, simply create it as a new text file. | |||
There was a problem hiding this comment.
[root] link needs updating to add another ../ at the front
|
|
||
| To view the Pi's current frequency, type: `cat /sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq`. Divide the result by 1000 to find the value in MHz. | ||
|
|
||
| To monitor the Pi's PSU voltage, you will need to use a multimeter to measure between the TP1 and TP2 power supply test points. More information is available in [power](../hardware/raspberrypi/power/README.md). |
There was a problem hiding this comment.
[power] link needs updating to add another ../ at the front
There was a problem hiding this comment.
../../hardware/raspberrypi/power/README.md - correct? Will do.
| @@ -0,0 +1,76 @@ | |||
| ## config.txt - Overclocking options | |||
|
|
|||
| **NOTE:** Setting any overclocking parameters to values other than those used by [raspi-config](raspi-config.md#overclock) will set a permanent bit within the SoC, making it possible to detect that your Pi has been overclocked. This was originally set to detect a void warranty if the device had been overclocked. Since September 19th 2012, you can overclock your Pi without affecting your warranty. For more information see the [blog post on Turbo Mode](https://www.raspberrypi.org/blog/introducing-turbo-mode-up-to-50-more-performance-for-free/). | |||
There was a problem hiding this comment.
[raspi-config] link needs updating to add another ../ at the front
|
Thanks for the link check @lurch - I'd missed relative links out of the pages ( I checked links in to the pages). Does point out an issue with using relative links.... I'll update the PR. |
|
I've started on this: will shout when I'm done. |
configuration/config-txt/video.md
Outdated
|
|
||
| #### disable_overscan | ||
|
|
||
| Set to `1` to disable [overscan](raspi-config.md#overscan). |
There was a problem hiding this comment.
[overscan] link needs updating to add another ../ at the front
Relative links are only a problem when the hierarchy of a page changes (which is hopefully a rare event). The good thing about relative links, is that it keeps the documentation self-contained, which means that it works equally well at https://github.com/raspberrypi/documentation as it does at https://www.raspberrypi.org/documentation/ |
|
@JamesH65 are you working on the relative links or do you want me to do it? |
|
OK @lurch, I have corrected the links specified above and committed to the PR branch. Will spend a few more minutes checking to see if I have missed any others. |
|
OK, this has been merged. Please keep an eye on the changes as they hit the real world, big changes so may be issues, although not found any yet. |
|
@JamesH65 is there any way of merging in my changes from commit 3a9769d? When I made the formatting edits to config.txt, I did it in two halves, and I didn't notice before that it was only 53363ad that got merged. If it's not possible, I can just redo the edits (it was the stuff to do with commands displaying in uppercase), but if it's an easy fix it would save a lot of typing. |
|
@LornaLynch When there's big merge conflicts (which I suspect there will probably be here, with the files having been split & renamed) it's often easier to just re-type the edits on the new version :-/ @JamesH65 While it's not 100% reliable (it often reports false errors when there aren't any), https://travis-ci.org/raspberrypi/documentation is useful for spotting any glaring errors. |
|
@JamesH65 Cool to hear that. Just for reference, here were previous places where I fixed things: https://github.com/raspberrypi/documentation/search?q=travis&type=Issues (of course once you get TravisCI working reliably, it'd be nice to enable that as an automatic status-check on each PR) |
|
If you want to let me know when you're ready for it, I can retype the edits. Don't want to cause any further conflicts by working on it at the same time as others. |
|
The new page structure has been merged so I think you can go ahead with
this.
J
…On 8 March 2017 at 18:34, Lorna Lynch ***@***.***> wrote:
If you want to let me know when you're ready for it, I can retype the
edits. Don't want to cause any further conflicts by working on it at the
same time as others.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#540 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ADqrHZ8KzCYUCzyu15A52wh-PUGmi52Bks5rjvSsgaJpZM4MSa6g>
.
--
James Hughes
Principal Software Engineer,
Raspberry Pi (Trading) Ltd
|
This is a reformat of the confix.txt documentation - the original file was huge, so has been split in to multiple files in a subfolder and indexed with a new README. I've fixed up all the links to the old file and removed it.