Author: sebastien.lelong
Date: Wed Mar 18 14:31:00 2009
New Revision: 869
Modified:
wiki/UsingJallibWrapper.wiki
Log:
not "test" action anymore
Modified: wiki/UsingJallibWrapper.wiki
==============================================================================
--- wiki/UsingJallibWrapper.wiki (original)
+++ wiki/UsingJallibWrapper.wiki Wed Mar 18 14:31:00 2009
@@ -5,7 +5,7 @@
= What is the "jallib" wrapper script ? =
-"jallib" script can handle common tasks when working with the SVN
repository. Tasks include compiling, validating, registering test results,
generating doc, etc... Whether you're a user, a tester or a developper, you
may want to have a look at it !
+"jallib" script can handle common tasks when working with the SVN
repository. Tasks include compiling, validating, indent code, generating
doc, etc... Whether you're a user or a developper, you may want to have a
look at it !
= Installing "jallib" =
@@ -47,24 +47,6 @@
* for linux & others, use your package distrib, or install using sources
* windows installation is straightforward
-Then install Cheetah 2.0.1:
-
- *
http://sourceforge.net/project/showfiles.php?group_id=28961&package_id=20864
- * installation is standard: unpack, and run `python setup.py install`
(note, under windows, if python is not in your %PATH%, this should look
like `c:\python25\python setup.py install`)
-
-Install YAML
-
- * http://pyyaml.org/wiki/PyYAML
- * again, install should be easy, `python setup.py install`
-
-Finally, install pysvn. This is the trickiest part. You'll need a pysvn
library built for SVN >=1.5 (and not SVN 1.4 for instance).
-
- * http://pysvn.tigris.org/project_downloads.html
- * linux: you can install it using the package distrib (eg. `apt-get
install python-svn`), but be sure you have it built against SVN >=1.5. You
can of course build it using sources
- * windows: use installation kit. Remember: python2.5 + svn1.5. This is
worked for me:
http://pysvn.tigris.org/files/documents/1233/43132/py25-pysvn-svn150-1.6.0-975.exe
- * macos: there are also mac os install kits (not tested)
- * if not correctly installed, you'll have an error message saying you
can't use this action because the library is not installed. Another error
will occur if you did not install the correct version ("client too old").
-
= Configuring "jallib" =
@@ -100,65 +82,10 @@
You can validate multiple files at a time. If all are compliant, it return
0, else if at least has failed, it returns a non-zero code status.
-== Testing ==
-
-`jallib help test` for more... This is probably where you can do the most
with jallib wrapper. The `test` action is here to help handling test
results, for each PIC. The wrapper is able to:
-
-=== Generating or updating a testing matrix (YAML file)===
-
-By exploring the sample map and trying to compile tests with board files,
to guess which tests are valid for a given PIC. Quite a nice feature :)
-
-{{{
-# if JALLIB_MATRIX env var exists, just do
-jallib test -u
-# or you can specify a file
-jallib test -u -f mymatrix.yaml
-}}}
-
-
-=== Working with a PIC subset (small matrix) ===
-
-Because the matrix can be quite big, and because you won't work with all
the PIC in the matrix (except Rob who has 250 PICs), you can create a small
matrix, dedicated your favorite PIC
-
-{{{
-# you have 16f88, 16f877 and 16f877a target chip, so...
-jallib test -u -f mysmallmatrix.yaml -n 16f88,16f877,16f877a
-}}}
+== reindent ==
-You now have a small matrix, for these PICs only. But remember: only the
big fat one have authority. That is, the huge matrix is the only one which
is under SVN, is the only which will be considered while generating html
files, for instance. So, what to do now ? Merge your small matrix with the
big one:
+`jallib help reindent` for more... This action takes a file as input,
re-indents it, and write the result back to the file. This is a convenient
way to fulfill on JSG requirement about code layout. By default, and this
is the jallib's standard, indentation is 3 spaces.
{{{
-# if configured, with env vars
-jallib test -m mymatrix.yaml
-# or, specifying the big matrix file
-jallib test -g bigfatmatrix.yaml -m mymatrix.yaml
-}}}
-
-Then, you can commit the big matrix file, so everybody knows you've tested
things. This feature also allows testers, without svn access, to send their
results to the list, then we, developers, integrate results to the main
matrix
-
-=== Registering test results ===
-
-Easy...
-
-{{{
-# this test is a success
-jallib test -a 16f88:new_test.jal:true
-# this one failed
-jallib test -a 16f877:new_test.jal:false
-}}}
-
-The SVN file revision is important, because it shows where you tested
things in the repository. With it, you can precisely track how things are
tested, with an history. Fortunately, if you have `pysvn` dependency
installed, the wrapper will check extract this information for you, so you
don't have to deal with it. If `pysvn` is not installed, you can specify it
(and also force it, that is by-passing pysvn):
-
-{{{
-jallib test -a 16f628:new_test.jal:t...@143
-}}}
-
-At any time, you can print the results:
-
-{{{
-jallib test -p 16f88
-}}}
-
-=== Generating test report (HTML files) ===
-
-Still W.I.P
\ No newline at end of file
+jallib reindent file.jal
+}}}
\ No newline at end of file
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
