Browse Source

Internal doc fixes for src/ rename

pull/952/head
Sami Vaarala 8 years ago
parent
commit
372677de20
  1. 2
      doc/bytecode.rst
  2. 2
      doc/code-issues.rst
  3. 6
      doc/compiler.rst
  4. 4
      doc/datetime.rst
  5. 4
      doc/debugger.rst
  6. 2
      doc/low-memory.rst
  7. 4
      doc/unicode-support.rst

2
doc/bytecode.rst

@ -332,7 +332,7 @@ detail here. Doing so would mean tedious documentation updates whenever
bytecode was changed, and documentation would then easily fall out of date.
The exact format is ultimately defined by the source code, see:
* ``src/duk_api_bytecode.c``
* ``src-input/duk_api_bytecode.c``
* ``tools/dump_bytecode.py``

2
doc/code-issues.rst

@ -1977,7 +1977,7 @@ the Date code.
The following can be used to find "leaks", accidental unwrapped calls::
$ python util/find_func_calls.py src/*.c src/*.h | \
$ python util/find_func_calls.py src-input/*.c src-input/*.h | \
grep -v -i -P ^duk_ | grep -v -P '^(sizeof|va_start|va_end|va_arg)' | \
sort | uniq

6
doc/compiler.rst

@ -334,11 +334,11 @@ not to be a code distribution format like e.g. Java bytecode.
The bytecode executor is the best source for documentation on exact bytecode
semantics at any given time. Opcode information must be sync in:
* ``src/duk_js_bytecode.h`` defines opcode names and various constants
* ``src-input/duk_js_bytecode.h`` defines opcode names and various constants
* ``src/duk_js_compiler.c`` emits bytecode
* ``src-input/duk_js_compiler.c`` emits bytecode
* ``src/duk_js_executor.c`` interprets bytecode
* ``src-input/duk_js_executor.c`` interprets bytecode
* ``debugger/duk_opcodes.yaml`` provides opcode metadata in a programmatic
format, used by the debugger Web UI for bytecode dumping

4
doc/datetime.rst

@ -126,9 +126,9 @@ There's an example dummy provider in:
You can also look into the Unix/Windows Date providers built into Duktape:
* ``src/duk_bi_date_unix.c``
* ``src-input/duk_bi_date_unix.c``
* ``src/duk_bi_date_windows.c``
* ``src-input/duk_bi_date_windows.c``
Platform dependencies
=====================

4
doc/debugger.rst

@ -260,7 +260,7 @@ mostly don't get a ``ctx`` argument); doing so may cause memory unsafe
behavior. As a concrete example, if a user read callback calls into the
Duktape API during a read operation, the API call may trigger garbage
collection. Because garbage collection may have arbitrary side effects,
the debugger command in progress (implemented in ``src/duk_debugger.c``)
the debugger command in progress (implemented in ``src-input/duk_debugger.c``)
may then break in a very confusing manner.
duk_debugger_detach()
@ -2342,7 +2342,7 @@ Duktape 1.5.0
-------------
The following list describes artificial keys included in Duktape 1.5.0, see
``src/duk_debugger.c`` for up-to-date behavior:
``src-input/duk_debugger.c`` for up-to-date behavior:
+---------------------------------+---------------------------+---------------------------------------------------------+
| Artificial property key | Object type(s) | Description |

2
doc/low-memory.rst

@ -380,7 +380,7 @@ The following may be appropriate when even less memory is available
+ ``util/example_user_builtins1.yaml``: examples of user builtins
+ ``src/builtins.yaml``: documents some more format details
+ ``src-input/builtins.yaml``: documents some more format details
+ Repo Makefile ``ajduk-rom`` target: illustrates how to run
``configure.py`` with user builtins

4
doc/unicode-support.rst

@ -29,7 +29,7 @@ Handling unicode case conversion, character classes etc in a compact code
size is bit challenging. The current solution is to fast path ASCII
characters and to use a bit-packed format for encoding case conversion
rules (e.g. range mappings). The rules are created by build-time Python
scripts (see ``src/`` directory) and decoded by run-time code such as the
scripts (see ``tools/`` directory) and decoded by run-time code such as the
parser with the help of ``duk_bitdecoder_ctx`` and ``duk_bd_decode()``.
.. note:: There are many Unicode specifications, and I'm not sure
@ -141,7 +141,7 @@ See also:
* http://www.unicode.org/faq/casemap_charprop.html.
* ``src/CaseConversion.java`` which allows easy testing of what Java does
* ``misc/CaseConversion.java`` which allows easy testing of what Java does
Context and locale sensitive rules
==================================

Loading…
Cancel
Save