docs: update documentation mistakes
authorBrendan Le Foll <brendan.le.foll@intel.com>
Tue, 25 Nov 2014 13:26:17 +0000 (13:26 +0000)
committerBrendan Le Foll <brendan.le.foll@intel.com>
Wed, 26 Nov 2014 11:43:30 +0000 (11:43 +0000)
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
docs/building.md
docs/npm.md

index f6812cc..612398f 100644 (file)
@@ -62,7 +62,6 @@ coverity-submit for your OS.
 ~~~~~~~~~~~~~{.sh}
 mkdir covbuild/ && cd covbuild
 cmake -DBUILDDOC=OFF -DBUILDSWIG=OFF ..
-cmake -DBUILDDOC=OFF -DBUILDSWIG=OFF ..
 cov-build --dir cov-int make
-tar caf mraa.tar..bz2 cov-int
+tar caf mraa.tar.bz2 cov-int
 ~~~~~~~~~~~~~
index 49e75c1..bdced1d 100644 (file)
@@ -15,13 +15,17 @@ we have generated for you.
 Recreating tarball
 ------------------
 
-From a checkout of mraa you can do the following to 'generate' this tarball
+From a checkout of mraa you can do the following to 'generate' this tarball.
+It's important to not leave a .git directory as npm will then consider the
+tarball contains a full git tree. Also you need a top level dir which matches
+the npm pkg name so we create one with a symlink and add the 'h' flag to tar to
+follow simlinks.
 
 ~~~~~~~~~~~~~{.sh}
 mkdir build
 cd build
 cmake -DBUILDSWIGNODE=ON  ..
 make npmpkg
-cd ../
-tar czv --exclude='build/*' --exclude='.git/*' -f /tmp/mraa.tar.gz .
+ln -s ../ mraa
+tar hczv --exclude='build*' --exclude='.gitignore' --exclude='.git' --exclude='build*/*' --exclude='.git/*' -f mraa.tar.gz mraa
 ~~~~~~~~~~~~~