From b967baa8118b34fb3fd36d4c3b8b1c21495f9aa4 Mon Sep 17 00:00:00 2001 From: Alyssa Rosenzweig Date: Fri, 17 Mar 2017 22:55:29 -0700 Subject: Cleanup some escaped symbols --- docs/misc/bbb_ehci.md | 24 ++++++++++++------------ docs/misc/index.md | 24 ++++++++++++------------ docs/misc/patch.md | 26 +++++++++++++------------- 3 files changed, 37 insertions(+), 37 deletions(-) (limited to 'docs/misc') diff --git a/docs/misc/bbb_ehci.md b/docs/misc/bbb_ehci.md index 0246a382..4d08fea7 100644 --- a/docs/misc/bbb_ehci.md +++ b/docs/misc/bbb_ehci.md @@ -103,7 +103,7 @@ section): ls /lib/modules/3.8.13-bone70/kernel/drivers/usb/gadget/g_dbgp.ko -Unload all other g\_\* modules: +Unload all other g\_* modules: # lsmod # rmmod g_multi @@ -131,7 +131,7 @@ Make sure that you have cross compiling environment for arm-linux-gnueabihf setup on your *host*. - On BBB: uname -r - this will give you version number like - 3.8.13-bone70 (I will refer to this as: \$mav.\$miv-\$lv: where + 3.8.13-bone70 (I will refer to this as: $mav.$miv-$lv: where mav=3.8, miv=13, lv=bone70 - Get the BBB kernel ready on your host for cross-compiling: @@ -153,7 +153,7 @@ arm-linux-gnueabihf setup on your *host*. the two different version of the kernel (3.8 and 3.10). I will use 3.8. (If using kernel 3.12 patch\_1 is not needed) - cd kernel (note that this is one more level: you should be in - \$work\_dir/kernel/kernel) + $work\_dir/kernel/kernel) - Apply the patches: @@ -169,12 +169,12 @@ arm-linux-gnueabihf setup on your *host*. see [scripts](http://www.fsfla.org/svn/fsfla/software/linux-libre/scripts/). - Get your current BBB kernel config (from: /boot/config-) - and copy it to your host as \$work\_dir/kernel/kernel/.config + and copy it to your host as $work\_dir/kernel/kernel/.config - Set proper version number: - - On your host, edit \$work\_dir/kernel/kernel/.config (the one + - On your host, edit $work\_dir/kernel/kernel/.config (the one you've just copied from BBB), find the line CONFIG\_LOCALVERSION="" and change - it to CONFIG\_LOCALVERSION="-\$lv", so it will look something + it to CONFIG\_LOCALVERSION="-$lv", so it will look something like: CONFIG\_LOCALVERSION="-bone70" - Also, make sure that: CONFIG\_USB\_G\_DBGP=m (If not, make menuconfig, and set @Device Drivers-> USB Support -> USB @@ -188,11 +188,11 @@ arm-linux-gnueabihf setup on your *host*. - on BBB, backup /lib/modules/3.8.13-bone70/kernel/drivers/usb/gadget (i.e. mv /lib/modules/3.8.13-bone70/kernel/drivers/usb/gadget - \$HOME) + $HOME) - copy the freshly compiled usb/gadget dir to /lib/modules/3.8.13-bone70/kernel/drivers/usb - restart BBB -- Remove all g\_\* modules (rmmod g\_<>) +- Remove all g\_* modules (rmmod g\_<>) - modprobpe g\_dbgp ### Configure libreboot with EHCI debug {#ConfigurelibrebootwithEHCIdebug} @@ -202,8 +202,8 @@ push debug messages to the EHCI debug port.\ If you've downloaded the binary distribution, you can check if it is properly configured in the following way: -- Go to the libreboot dist root directory cd \$libreboot\_bin -- Locate the rom image for your target (I will call it: \$img\_path) +- Go to the libreboot dist root directory cd $libreboot\_bin +- Locate the rom image for your target (I will call it: $img\_path) - Running the following command will extract the config in a file ./my\_config: @@ -282,7 +282,7 @@ libreboot (for now). - Plug the USB cable in the target's debug port (the one you found in step 1) and BBB's mini-B USB -- Make sure no other then g\_dbgp of the g\_\* modules is loaded on +- Make sure no other then g\_dbgp of the g\_* modules is loaded on your BBB - On the BBB: @@ -295,7 +295,7 @@ libreboot (for now). - You should see debug logs comming on your BBB console Note that this is not permanent on BBB, if you reboot it, you have to -rmmod g\_\* and modprobe g\_dbgp +rmmod g\_* and modprobe g\_dbgp ### Eneble EHCI Debug on the target's kernel (optional, recommended) {#EnebleEHCIDebugonthetargetskerneloptionalrecommended} diff --git a/docs/misc/index.md b/docs/misc/index.md index 44503755..497b1317 100644 --- a/docs/misc/index.md +++ b/docs/misc/index.md @@ -30,7 +30,7 @@ Included with libreboot is a script called 'powertop.debian'. Run this as root and it will setup powertop to run with \--auto-tune at boot time. Load the file in your text editor to see how it does that. -\$ **sudo ./resources/scripts/misc/powertop.debian** +$ **sudo ./resources/scripts/misc/powertop.debian** Might want to run with \--calibrate first @@ -60,7 +60,7 @@ when idle. So far we have use processor.max\_cstate=2 or idle=halt in GRUB. These consume power. Stop using them! Be root\ -**\$ su -** +**$ su -** Installed powertop:\ **\# pacman -S powertop** @@ -110,7 +110,7 @@ port on the dock and connect the other end to a 2nd system using your USB Serial adapter. On the 2nd system, you can try this (using GNU Screen):\ -**\$ sudo screen /dev/ttyUSB0 115200** +**$ sudo screen /dev/ttyUSB0 115200** How to quit GNU Screen: Ctrl+A then release and press K, and then press Y. @@ -211,7 +211,7 @@ duty cycle. see on bit 16. The cause of this issue is that i945, in contrast with to GM45, is set to work in BLM Legacy Mode. This makes backlight more complicated since the duty cycle is derived from 3 instead of 2 registers using the following -formula: if(BPC\[7:0\] <> xFF) then BPCR\[15:0\] \* BPC\[7:0\] +formula: if(BPC\[7:0\] <> xFF) then BPCR\[15:0\] * BPC\[7:0\] Else BPCR\[15:0\] BPC is LBB - PCI Backlight Control Register, described on on page 315. BPCR is BLC\_PWM\_CTL described in @@ -230,12 +230,12 @@ is included in libreboot, and can be used to enable or disable this behaviour. Disable or enable beeps when removing/adding the charger:\ -\$ **sudo ./nvramtool -w power\_management\_beeps=Enable**\ -\$ **sudo ./nvramtool -w power\_management\_beeps=Disable** +$ **sudo ./nvramtool -w power\_management\_beeps=Enable**\ +$ **sudo ./nvramtool -w power\_management\_beeps=Disable** Disable or enable beeps when battery is low:\ -\$ **sudo ./nvramtool -w low\_battery\_beep=Enable**\ -\$ **sudo ./nvramtool -w low\_battery\_beep=Disable** +$ **sudo ./nvramtool -w low\_battery\_beep=Enable**\ +$ **sudo ./nvramtool -w low\_battery\_beep=Disable** A reboot is required, for these changes to take effect. @@ -249,10 +249,10 @@ Or look in **/sys/class/drm/card0-LVDS-1/edid** Alternatively you can use i2cdump. In Debian and Devuan, this is in the package i2c-tools.\ -\$ **sudo modprobe i2c-dev**\ -\$ **sudo i2cdump -y 5 0x50** (you might have to change the value for +$ **sudo modprobe i2c-dev**\ +$ **sudo i2cdump -y 5 0x50** (you might have to change the value for -y)\ -\$ **sudo rmmod i2c-dev**\ +$ **sudo rmmod i2c-dev**\ You'll see the panel name in the output (from the EDID dump). If neither of these options work (or they are unavailable), physically @@ -280,7 +280,7 @@ laptop. If power usage is a concern, then you should not use this. To disable c-states, do this in GNU+Linux:\ **for i in /sys/devices/system/cpu/cpu/cpuidle/state/disable; do echo 1 -> \$i; done** +> $i; done** You can reproduce this issue more easily by sending lots of traffic across subnets on the same interface (NIC). diff --git a/docs/misc/patch.md b/docs/misc/patch.md index 9f6125c5..ee594a9e 100644 --- a/docs/misc/patch.md +++ b/docs/misc/patch.md @@ -12,11 +12,11 @@ Apply a patch ============= To apply a patch to a single file, do that in it's directory:\ -**\$ patch < foo.patch** +**$ patch < foo.patch** Assuming that the patch is distributed in unified format identifying the file the patch should be applied to, the above will work. Otherwise:\ -**\$ patch foo.txt < bar.patch** +**$ patch foo.txt < bar.patch** You can apply a patch to an entire directory, but note the "p level". What this means is that inside patch files will be the files that you @@ -25,7 +25,7 @@ the files ane located on your own computer instead of on the computer where the patch was created. 'p' level instructs the 'patch' utility to ignore parts of the path name to identify the files correctly. Usually a p level of 1 will work, so you would use:\ -**\$ patch -p1 < baz.patch** +**$ patch -p1 < baz.patch** Change to the top level directory before running this. If a patch level of 1 cannot identify the files to patch, then inspect the patch file for @@ -33,14 +33,14 @@ file names. For example:\ **/home/user/do/not/panic/yet.c** and you are working in a directory that contains panic/yet.c, use:\ -**\$ patch -p5 < baz.patch** +**$ patch -p5 < baz.patch** You usually count one up for each path separator (forward slash) removed from the beginning of the path, until you are left with a path that exists in the current working directory. The count is the p level. Removing a patch using the -R flag\ -**\$ patch -p5 -R < baz.patch** +**$ patch -p5 -R < baz.patch** [Back to top of page.](#pagetop) @@ -50,13 +50,13 @@ Create a patch with diff ======================== Diff can create a patch for a single file:\ -**\$ diff -u original.c new.c > original.patch** +**$ diff -u original.c new.c > original.patch** For diff'ing a source tree:\ -**\$ cp -R original new** +**$ cp -R original new** Do whatever you want in new/ and then diff it:\ -**\$ diff -rupN original/ new/ > original.patch** +**$ diff -rupN original/ new/ > original.patch** [Back to top of page.](#pagetop) @@ -70,13 +70,13 @@ git is something special. Note: this won't show new files created. Just make whatever changes you want to a git clone and then:\ -**\$ git diff > patch.git** +**$ git diff > patch.git** Note the git revision that you did this with:\ -**\$ git log** +**$ git log** Alternatively (better yet), commit your changes and then use:\ -\$ **git format-patch -N**\ +$ **git format-patch -N**\ Replace N with the number of commits that you want to show. [Back to top of page.](#pagetop) @@ -90,10 +90,10 @@ it really is. Now to apply that patch in the future, just git clone it again and do with the git revision you found from above:\ -**\$ git reset \--hard REVISIONNUMBER** +**$ git reset \--hard REVISIONNUMBER** Now put patch.git in the git clone directory and do:\ -**\$ git apply patch.git** +**$ git apply patch.git** If you use a patch from git format-patch, then use **git am patch.git** instead of **git apply patch.git**. git-am will re-create the commits -- cgit v1.2.3-70-g09d2