Update patch instructions and architecture discovery process.
authorMarvin Arnold <marvinmarnold@gmail.com>
Thu, 29 Sep 2016 19:16:52 +0000 (14:16 -0500)
committerMarvin Arnold <marvinmarnold@gmail.com>
Thu, 29 Sep 2016 19:16:52 +0000 (14:16 -0500)
Signed-off-by: Marvin Arnold <marvinmarnold@gmail.com>
development.txt
docs/index.txt

index e4fb09b768c0cc45bff0b16f0e139cdb241c6aa6..66c80c1f201c326bd89a9be172a3539183746dd3 100644 (file)
@@ -57,17 +57,20 @@ git clone https://git.lede-project.org/web.git
 
 === Submitting Patches
 
-The biggest difference is that we now accept pull requests. The tree that shall
-be pulled from needs to be hosted publicly. Small fixes and minor patches can
-also be submitted via the
-https://lists.infradead.org/mailman/listinfo/lede-dev[development mailing list].
-Submissions should follow these rules
+The biggest difference is that we now accept pull requests. Patches can be submitted as either a pull request on Github or small fixes and minor patches can also be submitted via the mailing list. Submissions should follow these rules:
 
+. A `Signed-off-by` line must be added to your commit / patch in accordance with Section 1.1 of the https://www.kernel.org/doc/Documentation/SubmittingPatches[Linux Kernel patches guide].
+.. Git: `git commit --signoff`
+.. Email: Just add line like `Signed-off-by: Random J Developer <random@developer.example.org>` to the top patch.
 . TBD
 
-All patches need to be sent in a format that they are listed in https://patchwork.ozlabs.org/project/lede/list/[patchwork].
-If the patch does not get listed in patchwork then it won't get processed.
+==== Github
 
+There are Github mirrors of the https://github.com/lede-project/source[source] and https://github.com/lede-project/web[web] repos. Simply fork the project to a public repo and submit a pull request.
+
+==== Email
+
+Send an email to the https://lists.infradead.org/mailman/listinfo/lede-dev[development mailing list]. All patches need to be sent in the same format as those that are listed on https://patchwork.ozlabs.org/project/lede/list/[patchwork]. If the patch does not get listed in patchwork then it won't get processed. For example, to print a patch for the most recent commit, `git format-patch -1 --stdout`. Double check that your output conforms before sending.
 
 === Staging Trees
 
index e9bc271090f829f21e93b373caf3a767d3b0cb9c..aff3368fa21ce2edc8207c646f4fa34ef3f49938 100644 (file)
@@ -5,24 +5,25 @@ title: Getting Started with LEDE
 
 == Getting Started with LEDE
 
-LEDE is based on link:https://wiki.openwrt.org/doc/start[OpenWrt] &mdash; most of the operational aspects of the two projects are identical. 
-This document frequently refers to pages of the OpenWrt wiki. 
+LEDE is based on link:https://wiki.openwrt.org/doc/start[OpenWrt] &mdash; most of the operational aspects of the two projects are identical.
+This document frequently refers to pages of the OpenWrt wiki.
 
 Although there are many ways to install LEDE on your device and complete its initial configuration, the following steps are reliable:
 
 . *Flash the LEDE firmware image into your device.* The exact process is device-specific.
 Follow the OpenWrt links below to find the required information for your device:
-.. *Find your device's architecture and processor types.* 
+.. *Find your device's architecture and processor types.*
 The "Device Page" of the link:https://wiki.openwrt.org/toh/start[OpenWrt Table of Hardware] will contain this information.
-.. *Download the proper LEDE firmware image to your computer* from link:https://downloads.lede-project.org/snapshots/targets/[downloads.lede-project.org.] 
+If you have an unbranded / low-end / low-cost router that came shipped with OpenWrt / LEDE, you can find out the architecture it is using by connecting to it over ssh and opening `/proc/cpuinfo`. A combination of the `system type` and `machine` is what you are looking for.
+.. *Download the proper LEDE firmware image to your computer* from link:https://downloads.lede-project.org/snapshots/targets/[downloads.lede-project.org.]
 The directory structure for LEDE is identical to OpenWrt's downloads.
 .. *Follow the flashing instructions* on the OpenWrt Device Page.
 .. On routers: *Connect via Ethernet using DHCP.* After flashing, make sure your computer is connected to a Local Area Network (LAN) port of the router using DHCP.
 .. On other devices: *Connect the device to your router.* The device will acquire an address using DHCP. Check your router's web-interface to learn which address it got.
 . *SSH to the device.* +
-In your terminal program, enter `ssh root@192.168.1.1` (on other devices, replace 192.168.1.1 with the address assigned to the device by your router). You can follow along with the steps below in the link:transcript.html[SSH Transcript].  
+In your terminal program, enter `ssh root@192.168.1.1` (on other devices, replace 192.168.1.1 with the address assigned to the device by your router). You can follow along with the steps below in the link:transcript.html[SSH Transcript].
 . *Set the password.* +
-LEDE ships without a password. Enter `passwd` and type the new password twice. 
+LEDE ships without a password. Enter `passwd` and type the new password twice.
 _Note: Use a good password: it secures your home network.
 Write it on the bottom of the device so you don't forget._
 . *Connect the Wide Area Network (WAN) port (if any) of the device to "the internet".* +
@@ -32,7 +33,7 @@ Type `ping 8.8.8.8` (that is Google's DNS server.) If the previous step worked,
 . *Update the packages, then install the LuCI web configuration package.* +
 We recommend the SSL-based package, but you could use the non-SSL version (named 'luci', not 'luci-ssl').
 .. Enter `opkg update`
-.. Enter `opkg install luci-ssl` to get the SSL-based web GUI. 
+.. Enter `opkg install luci-ssl` to get the SSL-based web GUI.
 . *At this point, the Web GUI is available.* +
 Go to https://192.168.1.1 to complete configuration.