Documentation cleanup

Author: jetsonhacks

README.md

@@ -1,36 +1,89 @@
 # buildJetsonTX1Kernel
-Scripts to help build the 4.4.38 kernel and modules onboard the Jetson TX1 (L4T 28.1, JetPack 3.1). For previous versions, visit the 'tags' section.
+Scripts to help build the 4.4.38 kernel and modules onboard the Jetson TX1 (L4T 28.2, JetPack 3.2). For previous versions, visit the 'tags' section.
 
-<em><strong>Note:</strong> The kernel source version must match the version of firmware flashed on the Jetson. For example, the source for the 4.4.38 kernel here is matched with L4T 28.1. This kernel compiled using this source tree will not work with newer versions or older versions of L4T, only 28.1.</em>
+<em><strong>Note:</strong> The kernel source version must match the version of firmware flashed on the Jetson. For example, the source for the 4.4.38 kernel here is matched with L4T 28.2. This kernel compiled using this source tree will not work with newer versions or older versions of L4T, only 28.2.</em>
 
 
 As of this writing, the "official" way to build the Jetson TX1 kernel is to use a cross compiler on a Linux PC. These scripts are an alternative which builds the kernel onboard the Jetson itself. These scripts will download the kernel source to the Jetson TX1, wrangle some of the Makefiles to make them work on the Jetson, and then compile the kernel and selected modules. The newly compiled kernel can then be installed.
 
-WARNING: After flashing the Jetson TX1, there is a limited amount of room on the device. After completing these scripts there will be NO space on the device. You MUST remove some of the files that were added in the /usr/src directory. You should store the /usr/src/kernel directory offboard (like on a SATA drive or USB stick) along with the compressed sources before deleting them. You may want to use them again later.
+<strong>WARNING:</strong> After flashing the Jetson TX1, there is a limited amount of room on the device. You should modify the kernel directly after flashing the device. After completing these scripts there will be little space left on the device. Afterwards, you should remove some of the files that were added in the /usr/src directory. You may want to store the /usr/src/kernel directory offboard (like on a SATA drive or USB stick) along with the compressed sources before deleting them as you may want to use them again later.
 
-These scripts are for building the kernel for the 64-bit L4T 28.1 (Ubuntu 16.04 based) operating system on the NVIDIA Jetson TX1. The scripts should be run directly after flashing the Jetson with L4T 28.1 from a host PC. There are three scripts:
+These scripts are for building the kernel for the 64-bit L4T 28.2 (Ubuntu 16.04 based) operating system on the NVIDIA Jetson TX1. The scripts should be run directly after flashing the Jetson with L4T 28.2 from a host PC. There are five scripts:
 
 <strong>getKernelSources.sh</strong>
 
-Downloads the kernel sources for L4T 28.1 from the NVIDIA website, decompresses them and opens a graphical editor on the .config file. 
+Downloads the kernel sources for L4T 28.2 from the NVIDIA website, decompresses them and opens a graphical editor on the .config file. 
+
+<strong>getKernelSourcesNoGUI.sh</strong>
+
+Downloads the kernel sources for L4T 28.2 from the NVIDIA website, decompresses them. This is useful when using SSH, or you prefer a different method of editing the .config file. 
 
 <strong>makeKernel.sh</strong>
 
-This script applies a few patches to makefiles in the kernel source, and then compiles the kernel and modules using make.
+This script compiles the kernel and modules using make.
 
 <strong>copyImage.sh</strong>
 
-Copies the Image file created by compiling the kernel to the /boot directory
+Copies the Image file created by compiling the kernel to the /boot directory. If you modify the kernel, you will probably want to make a copy of the original kernel image (/boot/Image) before copying over the newly generated one. You will also want to modify /boot/extlinux/extlinux.conf so that you can boot from the new Image or the old Image in case something untowards happens. That way, you will be able to select the old Image through the serial console.
 
-<strong>Notes:</strong> 
+<strong>Note:</strong> The Image file is copied to the boot directory of the current root directory device. The Jetson generally boots from the internal eMMC. If you are developing on external media (such as a SSD or USB drive) you will probably need to manually copy the Image file to the /boot directory of the eMMC. Refer to the script for the location of the Image file in the source tree.
 
-The kernel source files are downloaded in a .tgz2 format. After compilation you may want to remove those files. The files are located in /usr/src You will need to use sudo to remove the files, as they are in a system area. The work directory 'sources' contains kernel_src-txt1.tbz2, you can remove that directory. The file 'source_release.tbz2' is a much larger file that holds the kernel sources as well as many other TX1 specific source packages. You can make a backup of source_release.tbz2 before deleting it.
+<strong>removeAllKernelSources.sh</strong>
+Removes all of the kernel sources and compressed source files. You may want to make a backup of the files before deletion.
 
-You may want to save the newly built Image and modules to external media so that can be used to flash a Jetson image, or clone the disk image.
+
+<strong>Notes:</strong> 
 
 These scripts make only the kernel Image and Modules. You will need to modify the scripts if more are needed.
 
-The copyImage.sh script copies the Image to the current device. If you are building the kernel on an external device, for example a SSD, you will want to copy the Image file over to the eMMC in the eMMC /boot directory if you are booting from the eMMC and using external storage as your root directory. 
+<strong>IMPORTANT</strong>The copyImage.sh script copies the Image to the current device. If you are building the kernel on an external device, for example a SSD, you will want to copy the Image file over to the eMMC in the eMMC /boot directory if you are booting from the eMMC and using external storage as your root directory. 
+
+
+### Release Notes
+April, 2018
+* v1.0-L4T28.2
+* L4T 28.2 (JetPack 3.2)
+* Add getKernelSourcesNoGUI.sh for cases where the user does not want to edit the .config file through a GUI.
+* Add removeAllSources.sh for removing kernel sources and compressed files after the kernel is built.
+* Check to make sure that the version of the kernel matches the sources to download
+
+March, 2018
+* v1.0-L4T28.1
+* L4T 28.1 (JetPack 3.1)
+
+July, 2017
+* v1.0-L4T24.2.1
+* L4T 24.2.1 
+
+April, 2017
+* v1.0-L4T24.2
+* L4T 24.2
+
+## License
+MIT License
+
+Copyright (c) 2017-2018 Jetsonhacks
+Copyright (c) 2015-2018 Raffaello Bonghi (jetson_easy)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
 
 
 

getKernelSources.sh

@@ -20,7 +20,7 @@ else
    echo ""
    echo "This repository branch is for installing the kernel sources for L4T "$L4TTarget 
    echo "You are attempting to use these kernel sources on a L4T "$JETSON_L4T "system."
-   echo "The kernel sources do not match their L4T release.!"
+   echo "The kernel sources do not match their L4T release!"
    echo ""
    echo "Please git checkout the appropriate kernel sources for your release"
    echo " "

scripts/getKernelSources.sh

@@ -4,7 +4,8 @@ apt-get update
 apt-get install qt5-default pkg-config -y
 cd /usr/src
 wget -N http://developer.download.nvidia.com/embedded/L4T/r28_Release_v2.0/GA/BSP/tx1_sources.tbz2
-sudo tar -xvf tx1_sources.tbz2 public_release/kernel_src.tbz2
+echo "Expanding sources, please wait"
+tar -xvf tx1_sources.tbz2 public_release/kernel_src.tbz2
 tar -xvf public_release/kernel_src.tbz2
 # Space is tight; get rid of the compressed kernel source
 rm -r public_release

scripts/getKernelSourcesNoGUI.sh

@@ -4,7 +4,8 @@ apt-get update
 apt-get install pkg-config -y
 cd /usr/src
 wget -N http://developer.download.nvidia.com/embedded/L4T/r28_Release_v2.0/GA/BSP/tx1_sources.tbz2
-sudo tar -xvf tx1_sources.tbz2 public_release/kernel_src.tbz2
+echo "Expanding sources, please wait"
+tar -xvf tx1_sources.tbz2 public_release/kernel_src.tbz2
 tar -xvf public_release/kernel_src.tbz2
 # Space is tight; get rid of the compressed kernel source
 rm -r public_release