docs/writing-rules.txt

   1 // -*- mode:doc; -*-
   2 // vim: set syntax=asciidoc:
   3
   4 Coding style
   5 ------------
   6
   7 Overall, these coding style rules are here to help you to add new files in
   8 OpenADK or refactor existing ones.
   9
  10 [[writing-rules-config-in]]
  11
  12 +Config.in+
  13 ~~~~~~~~~~~
  14
  15 +Config.in+ files contain entries for almost anything configurable in
  16 OpenADK. Mostly all Config.in files for packages are autogenerated and
  17 should not be manually edited. The following rules apply for the top level
  18 Config.in, for the files in target/config and target/linux/config.
  19
  20 An entry has the following pattern:
  21
  22 ---------------------
  23 config ADK_TARGET_FOO
  24         bool "foo"
  25         select BR2_PACKAGE_LIBBAR
  26         depends on ADK_PACKAGE_LIBBAZ
  27         default n
  28         help
  29           This is a comment that explains what foo is.
  30
  31           http://foo.org/foo/
  32 ---------------------
  33
  34 * The +bool+, +depends on+, +default+, +select+ and +help+ lines are indented
  35   with one tab.
  36
  37 * The help text itself should be indented with one tab and two
  38   spaces.
  39
  40 The +Config.in+ files are the input for the configuration tool
  41 used in OpenADK, which is an enhanced version of _Kconfig_. For further
  42 details about the _Kconfig_ language, refer to
  43 http://kernel.org/doc/Documentation/kbuild/kconfig-language.txt[].
  44
  45 [[writing-rules-mk]]
  46
  47 +Makefile+
  48 ~~~~~~~~~~
  49
  50 * Header: The file starts with a license header.
  51 +
  52 ---------------------
  53 # This file is part of the OpenADK project. OpenADK is copyrighted
  54 # material, please see the LICENCE file in the top-level directory.
  55 ---------------------
  56 +
  57 * Assignment: use +:=+ or ++=+ followed by two tabs:
  58 +
  59 ---------------------
  60 PKG_VERSION:=           1.0
  61 PKG_BUILDDEP+=          libfoo
  62 ---------------------
  63 +
  64
  65 * Indentation: use tab only:
  66 +
  67 ---------------------
  68 libfoo-install:
  69         $(CP) $(WRKINST)/usr/lib/libfoo*.so* \
  70                 $(IDIR_LIBFOO)/usr/lib
  71 ---------------------
  72 +
  73
  74 * Optional dependency:
  75
  76 ** Prefer multi-line syntax.
  77 ---------------------
  78 ifeq ($(ADK_PACKAGE_LIBFOO_WITH_PYTHON),y)
  79 CONFIGURE_ARGS+=        --with-python-support
  80 else
  81 CONFIGURE_ARGS+=        --without-python-support
  82 endif
  83 ---------------------
  84
  85 Documentation
  86 ~~~~~~~~~~~~~
  87
  88 The documentation uses the
  89 http://www.methods.co.nz/asciidoc/[asciidoc] format.
  90
  91 For further details about the http://www.methods.co.nz/asciidoc/[asciidoc]
  92 syntax, refer to http://www.methods.co.nz/asciidoc/userguide.html[].