OpenWRT Build System for CentOS 7

How does one create a "build system" (AKA Cross Compile / Cross-Compile / CrossCompile Build System) for OpenWRT?

Other Tutorials

Environment

  • Build System for Cross-Compiling: CentOS 7.8 (There seem to be some missing packages in CentOS 8, so CentOS 7.8 was chosen)
  • OpenWRT 19.07.3 (Linux Kernel 4.14.180)
  • Linksys WRT3200ACM Platform Information (see here for additional information)

Steps (as of 9.2020 for the above Environment)

All of the below assumes one is storing files in the user's home directory.

OpenWRT recommends NOT compiling as a root users. To bypass this restriction;

  • export FORCE_UNSAFE_CONFIGURE=1 (the export command adds the variable to the current user session, it will not persist if logging off, confirm with printenv or export -p)

Obtain Source Files from OpenWRT

  • To clone into the current directory: git clone -b openwrt-19.07 https://github.com/openwrt/openwrt.git (downloads the 19.07 branch of OpenWRT, which also includes the latest version, 19.07.3)
  • To clone into a specific directory: git clone -b openwrt-19.07 https://github.com/openwrt/openwrt.git WhatEverDirectoryName (downloads the 19.07 branch of OpenWRT, which also includes the latest version, 19.07.3)
    • To see repository, in web browser: https://git.openwrt.org/openwrt/
    • git tag (essentially shows available versions to build)
    • git branch (shows local versions of OpenWRT downloaded)
    • git branch -r (shows versions available for download)
  • Feeds
    • Documentation: https://openwrt.org/docs/guide-developer/feeds
    • ~/openwrt/feeds.conf.default
    • ./scripts/feeds update -a (A script from OpenWRT to makes sure all files are up to date)
    • ./scripts/feeds (by itself, no "sub-commands", shows available options)
    • ./scripts/feeds list -n (shows main categories of feeds)
      • Should show these Names: packages, luci, routing, and telephony
    • ./scripts/feeds list -r OneOfTheFeedNames (shows the available packages, names are equivalent to what would be found with opkg list)
    • Example: ./scripts/feeds install htop (an enhanced version of top)
      • Files will be downloaded here: ~/openwrt/package/feeds/packages/, which are symbolic links to: ~/openwrt/feeds/packages/admin
  • Checkout (not needed if a single branch like 19.07 is downloaded)
  • SDK
    • Download the SDK and uncompress it (which is equivalent to the git clone command above)
    • tar xf WhatEverFileName (be sure one is in the ~ directory)
    • OR... Do it manually (based on instructions from: https://openwrt.org/docs/guide-developer/helloworld/chapter1);
      • Remember, if the SDK has already been downloaded an error similar to: destination path X already exists and is not an empty directory.
      • ...so skip to the ./scripts/feeds update -a
        • git clone -b openwrt-19.07.3 https://github.com/openwrt/openwrt.git ~/openwrtSDK (NOTE: The instructions at the above address do not provide the correct URL when cloning)
        • git checkout v19.07.3 (If a specific version is specified there is no need to "checkout" a version as specified in the same instructions, plus it appears since the instructions have been written there are other naming conventions too, like openwrt-19.07, but choosing a specific version is better.)
        • make distclean wipes out all configuration, starts from a clean slate
        • ./scripts/feeds update -a: Downloads pa
    • ./scripts/feeds update -a
    • ./scripts/feeds install WhatEverPackageName
    • ToolChain Directory: ~/openwrt/staging_dir/
  • Package Building
  • Headers

Environment Variables

export FORCE_UNSAFE_CONFIGURE=1

Standard Location: PATH=~/openwrt/staging_dir/host/bin:$PATH

For examples on OpenWRT "Hello World" Examples: export PATH=/home/buildbot/source/staging_dir/host/bin:$PATH

For persistent settings across reboots or logins: Add to ~/.bash_profile file

feeds.conf.default, feeds.conf, ~/openwrt/feeds.con, ~/openwrt/

Script that attempts to set Linux environment default variables for Make / Cmake: ~/openwrt/staging_dir/host/share/cmake-3.15/Modules/Platform/UnixPaths.cmake

Other package default path variables ~/openwrt/include/package-defaults.mk

  • Created when git clone is used
    • Feeds Directory: ~/openwrt/feeds/packages/admin, utils, etc.
    • Feeds Symbolic Links in this Directory (for convenience?): ~/openwrt/package/feeds/packages/ (created when the ./scripts/feeds update -a command is used)

Notes on 9.7.2020

On Monday 9.7.2020 during the late afternoon (UTC-8) it was observed that OpenWRT 19.07.4 was released on Tuesday 9.8.2020. This would seem to indicate the server for OpenWRT downloads is somewhere in Europe.

The following interesting observations were made after the above noted event

  • git tag : Lists all "major" and "minor" version branches of OpenWRT available.
    • v17.01.0
    • v17.01.0-rc1
    • v17.01.0-rc2
    • v17.01.1
    • v17.01.2
    • v17.01.3
    • v17.01.4
    • v17.01.5
    • v17.01.6
    • v17.01.7
    • v18.06.0
    • v18.06.0-rc1
    • v18.06.0-rc2
    • v18.06.1
    • v18.06.2
    • v18.06.3
    • v18.06.4
    • v18.06.5
    • v18.06.6
    • v18.06.7
    • v18.06.8
    • v19.07.0
    • v19.07.0-rc1
    • v19.07.0-rc2
    • v19.07.1
    • v19.07.2
    • v19.07.3
    • v19.07.4
  • git branch -r : Shows available "major versions" of OpenWRT available.
    •   origin/HEAD -> origin/master
    •   origin/lede-17.01
    •   origin/master
    •   origin/openwrt-18.06
    •   origin/openwrt-19.07
  • git clone -b v19.07.3 https://github.com/openwrt/openwrt.git produces the following output
    • Cloning into '/root/openwrtSDK'... remote: Enumerating objects: 13, done. remote: Counting objects: 100% (13/13), done. remote: Compressing objects: 100% (11/11), done. remote: Total 530753 (delta 0), reused 6 (delta 0), pack-reused 530740 Receiving objects: 100% (530753/530753), 183.81 MiB | 3.68 MiB/s, done. Resolving deltas: 100% (362276/362276), done. Note: checking out 'f3f38f40da74a193b4177be8d0fa746d00a753ea'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b new_branch_name
    • ...and git branch produces this output: fatal: Not a git repository (or any of the parent directories): .git. (Given that "HEAD" refers to a local copy of OpenWRT, this is not an issue)
  • git clone -b openwrt-19.07 https://github.com/openwrt/openwrt.git produces the following output
    • Cloning into '/root/openwrt-19.07'... remote: Enumerating objects: 13, done. remote: Counting objects: 100% (13/13), done. remote: Compressing objects: 100% (11/11), done. remote: Total 530753 (delta 0), reused 6 (delta 0), pack-reused 530740 Receiving objects: 100% (530753/530753), 183.81 MiB | 3.69 MiB/s, done. Resolving deltas: 100% (362276/362276), done.
    • ...and git branch produces this output: * openwrt-19.07 (the asterisk indicates the "checked out" version if multiple versions existed)
  • On 9.6.2020 this was contents of the feeds file included with cloning OpenWRT using openwrt-19.07;
    • src-git base https://git.openwrt.org/openwrt/openwrt.git;v19.07.3
    • src-git packages https://git.openwrt.org/feed/packages.git^2e6bd4cb86682b224803325127d3f777d40b3231
    • src-git luci https://git.openwrt.org/project/luci.git^fb2f36306756d0d0782dcab8413a8bb7ec379e54
    • src-git routing https://git.openwrt.org/feed/routing.git^3f8571194c2765ed31aa73459e86c2ebf943d27d
    • src-git telephony https://git.openwrt.org/feed/telephony.git^036cd451c35b82b3d8cac519864986894d9f6958
  • On 9.7.2020 this was contents of the feeds file included with cloning OpenWRT with both the openwrt-19.07 and v19.07.3;
    • src-git packages https://git.openwrt.org/feed/packages.git;openwrt-19.07
    • src-git luci https://git.openwrt.org/project/luci.git;openwrt-19.07
    • src-git routing https://git.openwrt.org/feed/routing.git;openwrt-19.07
    • src-git telephony https://git.openwrt.org/feed/telephony.git;openwrt-19.07


Notes from 9.10.2020

When using the ./scripts/feeds update -a command, the First Top Tip is: The Directory defined in feeds.conf or feeds.conf.default with the src-link command / directive that contains the path to a feed must have a directory, subdirectory structure, Makefile.

If the Makefile file for a project named helloworld is located in /WhatEverPath/examples/helloworld/Makefile, the the following applies in the feeds.conf or feeds.conf.default file;

  • Nope, won't work: src-link examples /WhatEverPath/examples/helloworld
  • This will work: examples /WhatEverPath/examples
  • Oh, and no trailing / (forward slash)
  • If it isn't done correctly, this unhelpful error message will occur: ... *** target pattern contains no `%'.  Stop.
    • For the above error, some sites note an issue with leading or trailing spaces on any line (does not include spaces after a command / directive) and recommending TABs instead. But after testing with leading and trailing spaces in an attempt to produce the error, it appears that the OpenWRT developers corrected this issue within their script (IE, most errors due to spaces seem to have occurred in an era where only MAKE commands were used prior to the existence of the ./scripts/feeds script.
  • Also in the feeds.conf or feeds.conf.default file do NOT use a ~ (tilde) in the path (like for a home directory) as it will not allow the ./scripts/feeds update -a command to work properly (plus it won't produce an error message, it just produces a zero byte index file.)
  • And be sure to run the ./scripts/feeds update -a and ./scripts/feeds/ install -a command (or instead of -a for ALL, target a specific package

How do the variables in scripts from OpenWRT get their default values? (https://openwrt.org/docs/guide-developer/packages as noted here, they can be defined in the Makefile file)

pwd is a Linux command to get the current directory.



  • ~openwrtSDK/feeds/WhatEverDirectory/MakeFile: Modifications here will be reflected in "make menuconfig"
  • The symbolic links originally used in earlier examples are incomplete. There is NOT a directory to directory equivalent file / directory for symbolic links in ~/openwrtSDK/package/feeds. IE, the subfolders of all of the symbolic links in ~/openwrtSDK/package/feeds seem to be in a flat structure, where as the directories / files they point to are in a hierarchical structure.
  • The README files in the various ~/openWRT/feeds directories make reference to the feeds.conf file which seems to now be titled feeds.conf.default. Documentation seems to indicate either one of these file names will work, although the one ending in .default seems to trump feeds.conf if both are present.
  • In order for a new item to show up in make menuconfig: Add it to /
    • NO ./scripts/feeds/update needs to be run, if: something is manually added as a symbolic link.
    • OR
    • run the ./scripts/feeds install -a command (obviously this is a better choice)
  • Error Logs are located: ~/openwrtSDK/logs/package/feeds/
  • If duplicating a directory, start by changing the define Package/WhatEverName that contains: SECTION, TITLE, etc. and every other reference to the same WhatEverName
    • It was noticed at minimum, the last line: $(eval $(call BuildPackage,WhatEverName)) had to be changed too.