Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
batocera.linux_buildroot_modifications [2022/06/30 10:49] – rewrite patching section, moved below the steps for getting the package set up in the first place ataribatocera.linux_buildroot_modifications [2022/09/28 07:14] (current) – specifics atari
Line 2: Line 2:
  
 You may know me from former titles such as "Batocera Linux Buildroot Modifications" and "How to work on Batocera (and not recompile everything)". You may know me from former titles such as "Batocera Linux Buildroot Modifications" and "How to work on Batocera (and not recompile everything)".
 +
 +<WRAP center round info>
 +RPi3, the "per platform" example used here, was formerly known internally as ''rpi3'' in Batocera **v35** and lower. This is now ''bcm2837'' in **v36** and higher.
 +</WRAP>
  
 <WRAP center round tip> <WRAP center round tip>
Line 25: Line 29:
   - download the package in the dl directory according to information from ''package/package-name/package-name.mk'' or ''package/batocera/package-name/package-name.mk''   - download the package in the dl directory according to information from ''package/package-name/package-name.mk'' or ''package/batocera/package-name/package-name.mk''
   - extract the package in ''output/build/package-name-version''   - extract the package in ''output/build/package-name-version''
-  - patch the package from ''*.patch'' files (files next to the ''.mk'' file or ''board/batocera/patches/'' or ''board/batocera/rpi/patches/'')+  - patch the package from ''*.patch'' files (files next to the ''.mk'' file or ''board/batocera/patches/'' or ''board/batocera/bcm2837/patches/'')
   - configure the package according to the ''.mk'' file   - configure the package according to the ''.mk'' file
   - build the package according to the ''.mk'' file   - build the package according to the ''.mk'' file
-  - install in the ''output/rpi3/host/'' staging directory, in case of libraries +  - install in the ''output/bcm2837/host/'' staging directory, in case of libraries 
-  - install in the ''output/rpi3/target/'' directory+  - install in the ''output/bcm2837/target/'' directory
  
-For each step, Buildroot creates an empty flag file. For example: ''%%.stamp_downloaded%%'' in ''output/rpi3/build/package-name-version''.+For each step, Buildroot creates an empty flag file. For example: ''%%.stamp_downloaded%%'' in ''output/bcm2837/build/package-name-version''.
  
 In case a step failed, just run ''make'' or ''make package-name'' again to restart/continue the build where you left. In case a step failed, just run ''make'' or ''make package-name'' again to restart/continue the build where you left.
  
-To completely rebuild a package:+To completely rebuild a package (for example an RPi 3 package):
  
-  rm -rf output/rpi3/build/package-name-version+  rm -rf output/bcm2837/build/package-name-version
   make package-name   make package-name
  
 For example, to build EmulationStation again from the latest ''master'' git version: For example, to build EmulationStation again from the latest ''master'' git version:
  
-  rm -rf output/rpi3/build/batocera-emulationstation-master+  rm -rf output/bcm2837/build/batocera-emulationstation-master
   make batocera-emulationstation   make batocera-emulationstation
      
Line 163: Line 167:
   - Configure the default emulator (if you've added a whole new system) with https://github.com/batocera-linux/batocera.linux/blob/master/package/batocera/core/batocera-configgen/configs/configgen-defaults.yml (if you're merely adding an emulator to an already existing system and you don't want to make it the default, no need to touch this file).   - Configure the default emulator (if you've added a whole new system) with https://github.com/batocera-linux/batocera.linux/blob/master/package/batocera/core/batocera-configgen/configs/configgen-defaults.yml (if you're merely adding an emulator to an already existing system and you don't want to make it the default, no need to touch this file).
   - Configure the default settings for particular architectures (such as if your emulator requires certain settings to function on a particular architecture) at https://github.com/batocera-linux/batocera.linux/blob/master/package/batocera/core/batocera-configgen/configs/.   - Configure the default settings for particular architectures (such as if your emulator requires certain settings to function on a particular architecture) at https://github.com/batocera-linux/batocera.linux/blob/master/package/batocera/core/batocera-configgen/configs/.
 +  - Add the system's shortname and a link to a page explaining the system (Wikipedia tends to be a good "default" but there are better sources out there) to the appropriate section in the [[:systems|systems page]] of this wiki.
   - (Optional) If you need to add an explanation for the emulator's exclusion from a particular platform for the [[https://batocera.org/compatibility.php|compatibility chart]], add it to https://github.com/batocera-linux/batocera.linux/blob/master/package/batocera/emulationstation/batocera-es-system/systems-explanations.yml   - (Optional) If you need to add an explanation for the emulator's exclusion from a particular platform for the [[https://batocera.org/compatibility.php|compatibility chart]], add it to https://github.com/batocera-linux/batocera.linux/blob/master/package/batocera/emulationstation/batocera-es-system/systems-explanations.yml
  
Line 173: Line 178:
 Let's say you want to work on the package "retroarch" to make it evolve via a patch. Let's say you want to work on the package "retroarch" to make it evolve via a patch.
  
-First, compile a complete version of Batocera for the architecture you will test. In this example, we will do so for ''rpi3''.+First, compile a complete version of Batocera for the architecture you will test. In this example, we will do so for RPi3.
  
 <code bash> <code bash>
 cd batocera.linux cd batocera.linux
-make rpi3-build+make bcm2837-build
 </code> </code>
  
Line 183: Line 188:
  
 <code bash> <code bash>
-mv output/rpi3/target output/rpi3/target_+mv output/bcm2837/target output/bcm2837/target_
 </code> </code>
  
Line 189: Line 194:
  
 <code bash> <code bash>
-cd output/rpi3/build/retroarch-version+cd output/bcm2837/build/retroarch-version
 </code> </code>
      
Line 198: Line 203:
 </code> </code>
  
-Make the modifications to the files you want now, keeping track of which files you edit. +Then add the file(s) you want to modify to the current commit:
- +
-Then add them to the current commit. Then compare the differences and save them to a "patch" file:+
  
 <code bash> <code bash>
 git add <the file(s) you modified> git add <the file(s) you modified>
 +</code>
 +
 +<WRAP center round tip>
 +Add all files with ''git add -A''.
 +</WRAP>
 +
 +Make the modifications to the files you want now.
 +
 +Then compare the differences and save them to a "patch" file:
 +
 +<code bash>
 git diff > ../../package/batocera/retroarch/001-mymodification.patch git diff > ../../package/batocera/retroarch/001-mymodification.patch
 </code> </code>
Line 211: Line 225:
 <code bash> <code bash>
 cd ../../.. cd ../../..
-rm -rf ouput/rpi3/build/batocera/retroarch-version+rm -rf ouput/bcm2837/build/batocera/retroarch-version
 </code> </code>
  
Line 223: Line 237:
 ===== Testing a package without compiling the entirety of Batocera ===== ===== Testing a package without compiling the entirety of Batocera =====
  
-It's possible to compile //just// the package you've modified and then transfer it over to your live Batocera installation using ''rsync''. First, compile the individual package [[#package_compilation|as explained above]] with ''make rpi3-pkg PKG=<package name>'' and then run:+It's possible to compile //just// the package you've modified and then transfer it over to your live Batocera installation using ''rsync''. First, compile the individual package [[#package_compilation|as explained above]] with ''make bcm2837-pkg PKG=<package name>'' and then run:
  
 <code bash> <code bash>
-rsync -av output/rpi3/target/ root@batocera.local:/+rsync -av output/bcm2837/target/ root@batocera.local:/
 </code> </code>
  
 This will sync up the contents of the target directory on your build machine with the Batocera machine. Feel free to immediately test your changes. If the changes are bad and you need to restore, simply reboot and the changes will not persist. To have them persist instead, run [[modify_the_system_while_it_s_running|batocera-save-overlay]] from the machine itself. This will sync up the contents of the target directory on your build machine with the Batocera machine. Feel free to immediately test your changes. If the changes are bad and you need to restore, simply reboot and the changes will not persist. To have them persist instead, run [[modify_the_system_while_it_s_running|batocera-save-overlay]] from the machine itself.
  
  • batocera.linux_buildroot_modifications.1656586163.txt.gz
  • Last modified: 4 years ago
  • by atari