CONSTRUCTION AREA
Go to file
Thomas Jarosch 66df5f3891 Improve core_alloc() / buflib_alloc() documentation
Document the fact that buffers are movable by default.
Care must be taken to not pass them to functions that yield().

Also clarify other things:
- Passing NULL as "ops" to buflib_alloc_ex() causes
  buffers to be movable by default (but not shrinkable).

- If you want shrinkable buffers during compaction,
  you have to provide a shrink callback.

- To disable buffer movement, you have to pass NULL
  for the move_callback inside the callback structure.

- The concept of default callbacks was removed
  long ago, remove the only reference of it.

Change-Id: I3bf0ea6b08b507d80a19f3c2c835aca32b3f7800
2015-01-02 18:51:15 +01:00
android Don't require a specific BUILD_TOOLS_VERSION. 2014-09-25 00:26:25 +02:00
apps Shortcuts: Add move callback for buflib allocations 2015-01-02 01:11:54 +01:00
backdrops Add Cabbiev2 port for 128x96x16 targets (Samsung YH-820), made by me. 2014-03-27 19:50:48 +00:00
bootloader Fix USB speed detection 2014-10-04 11:57:09 +02:00
debian Prepare new maemo release 2013-03-10 12:12:38 +01:00
docs Xworld - Another World interpreter for Rockbox 2014-12-23 23:48:12 +01:00
firmware Improve core_alloc() / buflib_alloc() documentation 2015-01-02 18:51:15 +01:00
flash Fix some more straggling stuff 2014-08-08 03:23:29 -04:00
fonts Remove superfluous executable bits on a bunch of files. 2011-06-08 14:22:03 +00:00
gdb Generate C file / header for svn version string 2010-05-27 09:41:46 +00:00
icons wpsbuild: Rewrite to fix various issues and support .fms 2012-06-10 21:20:36 +02:00
lib More standard conforming codec_realloc() 2014-12-27 17:33:24 +01:00
manual XWorld: cleanup 2014-12-28 02:48:42 +01:00
packaging Prepare unofficial pandora release 2013-03-10 14:09:30 +01:00
rbutil Introducing Targets iBasso DX50 & iBasso DX90 2014-09-18 18:19:01 +02:00
tools mkzenboot: Fix double close of bootfd on error 2014-12-20 15:18:46 +01:00
uisimulator Get the last errors I hope! 2014-08-30 01:29:18 -04:00
utils Remove useless assignment of 'len' 2014-12-20 15:52:35 +01:00
wps lcd-24bit: Introduce a 24-bit mid-level LCD driver 2014-06-21 00:15:53 +02:00
.gitattributes Add a gitattributes file for the migration. 2011-12-01 14:14:59 +00:00
.gitignore Add *.o and *.a to .gitignore 2012-05-16 11:26:22 +02:00

docs/README

               __________               __   ___.
     Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
     Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
     Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
     Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
                       \/            \/     \/    \/            \/

Build Your Own Rockbox

1. Clone 'rockbox' from git (or extract a downloaded archive).

   $ git clone git://git.rockbox.org/rockbox

     or

   $ tar xjf rockbox.tar.bz2

2. Create a build directory, preferably in the same directory as the firmware/
   and apps/ directories. This is where all generated files will be written.

   $ cd rockbox
   $ mkdir build
   $ cd build

3. Make sure you have sh/arm/m68k-elf-gcc and siblings in the PATH. Make sure
   that you have 'perl' in your PATH too. Your gcc cross compiler needs to be
   a particular version depending on what player you are compiling for. These
   can be acquired with the rockboxdev.sh script in the /tools/ folder of the
   source, or will have been included if you've installed one of the
   toolchains or development environments provided at http://www.rockbox.org/

   $ which sh-elf-gcc
   $ which perl

4. In your build directory, run the 'tools/configure' script and enter what
   target you want to build for and if you want a debug version or not (and a
   few more questions). It'll prompt you. The debug version is for making a
   gdb version out of it. It is only useful if you run gdb towards your target
   Archos.

   $ ../tools/configure

5. *ploink*. Now you have got a Makefile generated for you.

6. Run 'make' and soon the necessary pieces from the firmware and the apps
   directories have been compiled, linked and scrambled for you.

   $ make
   $ make zip

7. unzip the rockbox.zip on your music player, reboot it and
   *smile*.

If you want to build for more than one target, just create several build
directories and create a setup for each target:

   $ mkdir build-fmrecorder
   $ cd build-fmrecorder
   $ ../tools/configure

   $ mkdir build-player
   $ cd build-player
   $ ../tools/configure

Questions anyone? Ask on the mailing list. We'll be happy to help you!