Revision: 1168 Author: sebastien.lelong Date: Thu Aug 6 00:39:51 2009 Log: update sample/test sections http://code.google.com/p/jallib/source/detail?r=1168
Modified: /wiki/UnderstandingSvnStructure.wiki ======================================= --- /wiki/UnderstandingSvnStructure.wiki Mon Feb 2 09:43:13 2009 +++ /wiki/UnderstandingSvnStructure.wiki Thu Aug 6 00:39:51 2009 @@ -1,5 +1,5 @@ #summary understanding how the SVN repository is organized... -#labels Phase-QA +#labels Phase-Implementation,Phase-Design = Why having such a structure ? = @@ -76,14 +76,21 @@ == sample == -=== by_device === - -This section contains samples, organized by device. So, go the directory corresponding to your favorite target chip, and you'll find all available samples for this chip. These samples are _ready-to-compile_, so fell free to give a try, it's easy ! If you created a new sample, don't hesitate, *share your shiny new sample to the jallib group, we'll be pleased to add it to the repository*. - -=== test === +This section contains samples. Every samples are prefixed by PIC's name, so you should be able to easily get all samples for your favorite PIC. + +These samples are _ready-to-compile_, so fell free to give a try, it's easy ! If you created a new sample, don't hesitate, *share your shiny new sample to the jallib group, we'll be pleased to add it to the repository*. + +== test == In the "test" map, you'll find quite the same hierarchy as in "include". This is where remain test files. Test files are chip independent (there's no "include 16fxxxx"), and perform heavy tests on several important libraries (mainly core libraries, PIC-specific). So, for instance, in `test/peripheral/usart`, you'll find test dedidated to USART libraries. These tests are mixed up with a "board" file (from "board" directory). A _board_ file and a _test_ file gives a functional, compilable piece of code, which will perform the selected test on the selected target, using the selected board. "Woah" I hear you say... "What is it such complicated ?" It's not complicated. At least, this apparent complexity avoid code duplication, and permits to seperate the test logic, from the board/target chip setup. Each type of file focus on a specific task. Don't worry about all of this: unless you plan to contribute to jallib as a developper, you won't need all of these. But... we'd be please if you help :) + +=== unittest === + +A sub-section is about unittesting. You'll find files containing tests you can run using +`jallib` script: `jallib unittest <testfile>`. + +Unittesting is performed using PICShell libraries, files are being annotated with some special tags (like @assertEquals ...). These tests can be run in PC-silico, and does not require a PIC. There are here to tests some libraries and compiler's features, ensuring there's no regression. --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "jallib" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/jallib?hl=en -~----------~----~----~----~------~----~------~--~---
