docs/7 - Contributing to crosstool-NG.txt
author "Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
Tue Dec 13 23:32:39 2011 +0100 (2011-12-13)
branch1.13
changeset 2847 c0bf2319af08
parent 2563 e17f35b05539
child 2908 dcdb309b7967
permissions -rw-r--r--
scripts: fix dumping execution backtrace

Dumping the backtrace has been broken since changeset #652e56d6d35a:
scripts: execute each steps in a subshell

We can spawn sub-sub-shells in some cases.

The way the fault handler works is to dump the backtrace, but to avoid
printing it once for every sub-shell (which could get quite confusing),
it simply exits when it detects that it is being run in a sub-shell,
leaving to the top-level shell the work to dump the backtrace.

Because each step is executed in its own sub-shell, the variable arrays
that contain the step name, the source file and line number, are lost
when exiting the per-step sub-shell.

Hence, the backtrace is currently limited to printing only the top-level
main procedure of the shell.

Fix this thus:
- when dumping the bckatraces for the steps & the functions, remember
it was dumped, and only dump it if it was not already dumped
- at the top-level shell, print the hints

Also, rename the top-level step label.

Reported-by: Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
(transplanted from 4193d6e6a17430a177fa88c287879c2c35e319f3)
     1 File.........: 7 - Contributing to crosstool-NG.txt
     2 Copyright....: (C) 2010 Yann E. MORIN <yann.morin.1998@anciens.enib.fr>
     3 License......: Creative Commons Attribution Share Alike (CC-by-sa), v2.5
     4 
     5 
     6 Contributing to crosstool-NG  /
     7 _____________________________/
     8 
     9 
    10 Sending a bug report |
    11 ---------------------+
    12 
    13 If you need to send a bug report, please send a mail with subject
    14 prefixed with "[CT_NG]" with to following destinations:
    15     TO: yann.morin.1998 (at) anciens.enib.fr
    16     CC: crossgcc (at) sourceware.org
    17 
    18 
    19 Sending patches |
    20 ----------------+
    21 
    22 If you want to enhance crosstool-NG, there's a to-do list in the TODO file.
    23 
    24 When updating a package, please include the category and component in the
    25 start of the description. For example:
    26     cc/gcc: update to the Linaro 2011.09 release
    27 
    28 Here is the (mostly-complete) list of categories and components:
    29 
    30     Categories  | Components
    31     ------------+-------------------------------------------------------
    32     arch        | alpha, arm, mips, powerpc...
    33     cc          | gcc
    34     binutils    | binutils, elf2flt, sstrip
    35     libc        | eglibc, uClibc, glibc, newlib, mingw, none
    36     kernel      | linux, mingw32, bare-metal
    37     debug       | dmalloc, duma, gdb, ltrace, strace
    38     complibs    | gmp, mpfr, ppl, cloog, mpc, libelf
    39     comptools   | make, m4, autoconf, automake, libtool
    40     ------------+-------------------------------------------------------
    41                 | The following categories have no component-part:
    42     samples     | when adding/updating/removing a sample
    43     kconfig     | for stuff in the kconfig/ dir
    44     docs        | for changes to the documentation
    45     configure   | for changes to ./configure and/or Makefile.in
    46     config      | for stuff in config/ not covered above
    47     scripts     | for stuff in scripts/ not covered above
    48 
    49 
    50 Patches should come with the appropriate SoB line. A SoB line is typically
    51 something like:
    52    Signed-off-by: John DOE <john.doe@somewhere.net>
    53 
    54 The SoB line is clearly described in Documentation/SubmittingPatches , section
    55 12, of your favourite Linux kernel source tree.
    56 
    57 Add the following to your ~/.hgrc to make Mercurial check for the SoB
    58 line when committing:
    59     [hooks]
    60     pretxncommit.signoff = hg log --template '{desc}\n' -r $HG_NODE \
    61         | grep -qi '^signed-off-by:'
    62 
    63 You can also add any of the following lines if applicable:
    64     Acked-by:
    65     Tested-by:
    66     Reviewed-by:
    67 
    68 For larger or more frequent contributions, mercurial should be used.
    69 There is a nice, complete and step-by-step tutorial in section 'C'.