Skip to content

Commit

Permalink
Add extras/ dir, add READMEs for extras+examples
Browse files Browse the repository at this point in the history
  • Loading branch information
svaarala committed Oct 28, 2014
1 parent bb08e7c commit 749d8ec
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 1 deletion.
5 changes: 5 additions & 0 deletions dist-files/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ Duktape itself is widely portable, some of the examples are Linux only.
For instance the ``eventloop`` example illustrates how ``setTimeout()``
and other standard timer functions could be implemented on Unix/Linux.

The ``extras/`` directory provides utilities and modules which don't
comfortably fit into the main Duktape library because of footprint or
portability concerns. Extras are maintained and bug fixed code, but
don't have the same version guarantees as the main Duktape library.

The ``polyfills/`` directory provides a few replacement suggestions for
non-standard Javascript functions provided by other implementations.

Expand Down
10 changes: 10 additions & 0 deletions examples/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
================
Duktape examples
================

Examples for using Duktape. These support user documentation and are
intended as informative illustrations only.

Examples are unmaintained and are not production quality code. Bugs are
not not necessarily fixed, unless the bug makes the example misleading
as documentation.
13 changes: 13 additions & 0 deletions extras/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
==============
Duktape extras
==============

Extra modules and utilities. Extras provide functionality that doesn't
comfortably fit into the main Duktape library, perhaps for footprint or
portability reasons, but are still useful for most users.

Extras are maintained and will be bug fixed. However, they don't have the
same semantic versioning guarantees like the main Duktape library. Extras
may be dropped without warning as Duktape is versioned. For instance, if
an extra breaks due to Duktape changes and there is no time to fix it, the
missing extra won't block a release and will be dropped.
6 changes: 5 additions & 1 deletion util/make_dist.sh
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ rm -rf $DIST
mkdir $DIST
mkdir $DIST/src-separate
mkdir $DIST/src
mkdir $DIST/extras
mkdir $DIST/polyfills
#mkdir $DIST/doc
mkdir $DIST/licenses
Expand Down Expand Up @@ -196,7 +197,7 @@ for i in \
cp polyfills/$i $DIST/polyfills/ || exit 1
done


cp examples/README.rst $DIST/examples/ || exit 1
for i in \
README.rst \
duk_cmdline.c \
Expand Down Expand Up @@ -271,6 +272,9 @@ for i in \
cp examples/sandbox/$i $DIST/examples/sandbox/ || exit 1
done

cp extras/README.rst $DIST/extras/ || exit
# XXX: copy extras

for i in \
Makefile.cmdline \
Makefile.eventloop \
Expand Down
1 change: 1 addition & 0 deletions website/guide/versioning.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ <h2>Semantic versioning</h2>
guarantees). Such changes are noted in release notes, and the goal is to cause
a compile error when a no-longer-supported feature option is used so that any
incorrect assumptions can be fixed.</li>
<li>Extras distributed with Duktape (<code>extras/</code> directory).</li>
</ul>

<h2>Version naming</h2>
Expand Down

0 comments on commit 749d8ec

Please sign in to comment.