mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-08-23 17:48:35 +00:00

History

Eric Schulte 7e93b90f88 Standardized code block keywords Nick Dokos <nicholas.dokos@hp.com> writes: > Eric Schulte <schulte.eric@gmail.com> wrote: > >> The attached updated patch fixes a bug in the original. >> > > Minor problem in applying: > > ,---- > \| $ git apply ~/Mail/inbox/724 > \| /home/nick/Mail/inbox/724:671: trailing whitespace. > \| #+name: > \| /home/nick/Mail/inbox/724:599: new blank line at EOF. > \| + > \| warning: 2 lines add whitespace errors. > `---- The attached version fixes these issues, Thanks -- Eric >From 0e43d59ee8d46a63f86780a502de726271bc39de Mon Sep 17 00:00:00 2001 From: Eric Schulte <schulte.eric@gmail.com> Date: Fri, 28 Oct 2011 10:44:21 -0600 Subject: [PATCH] removing code block, results and call-line synonyms -- BREAKING CHANGE Following a round of on-list discussion many code block synonyms have been removed, moving forward the following syntax is valid. - call lines are specified with #+call: - code blocks are named with #+name: - results are named with #+name:, however results generated by a code block may still be labeled with #+results:, and tables named with #+tblname: will be considered to be named results The following function may be used to update an existing Org-mode buffer to the new syntax. (defun update-org-buffer () "Update an Org-mode buffer to the new data, code block and call line syntax." (interactive) (save-excursion (flet ((to-re (lst) (concat "^[ \t]#\\+" (regexp-opt lst t) "\$\\[\\([[:alnum:]]+\$\\]\\)?\\:[ \t]")) (update (re new) (goto-char (point-min)) (while (re-search-forward re nil t) (replace-match new nil nil nil 1)))) (let ((old-re (to-re '("RESULTS" "DATA" "SRCNAME" "SOURCE"))) (lob-re (to-re '("LOB"))) (case-fold-search t)) (update old-re "name") (update lob-re "call"))))) Note: If an old version of Org-mode (e.g., the one shipped with Emacs) is installed on your system many of the important variables will be pre-defined with a defvar and will not have their values automatically updated, these include the following. - org-babel-data-names - org-babel-result-regexp - org-babel-src-block-regexp - org-babel-src-name-regexp - org-babel-src-name-w-name-regexp It may be necessary to either remove the source code of older versions of Org-mode, or to explicitly evaluate the ob.el file. * lisp/ob-exp.el (org-exp-res/src-name-cleanup): Updated Documentation. * lisp/ob-lob.el (org-babel-block-lob-one-liner-regexp): Updated regular expression. (org-babel-inline-lob-one-liner-regexp): Updated regular expression. * lisp/ob-ref.el (org-babel-ref-resolve): Notice when something that looks like a data results may actually be a code block. * lisp/ob-table.el: Updated documentation. * lisp/ob.el (org-babel-src-name-regexp): Simplified regexp. (org-babel-get-src-block-info): Updated match strings. (org-babel-data-names): Simplified acceptable names. (org-babel-find-named-block): Indentation. (org-babel-find-named-result): Updated to not return a code block as a result. * lisp/org.el (org-fontify-meta-lines-and-blocks-1): Removing references to old syntactic elements. (org-additional-option-like-keywords): Removing references to old syntactic elements. * contrib/babel/library-of-babel.org: Updated to make use of the new syntax. * testing/examples/babel-dangerous.org: Updated to make use of the new syntax. * testing/examples/babel.org: Updated to make use of the new syntax. * testing/examples/ob-awk-test.org: Updated to make use of the new syntax. * testing/examples/ob-fortran-test.org: Updated to make use of the new syntax. * testing/lisp/test-ob.el: Removed two bad tests which tested the literal values of old regular expressions rather than their behavior.		2011-11-15 08:56:24 -07:00
..
contrib/lisp	ensure that the testing/contrib/lisp directory is created	2010-10-06 08:58:08 -06:00
examples	Standardized code block keywords	2011-11-15 08:56:24 -07:00
jump@820bb7d81b	now using newer version of jump.el -- run $ git submodule update	2010-10-21 13:05:59 +01:00
lisp	Standardized code block keywords	2011-11-15 08:56:24 -07:00
.gitignore	ignore testing/ert, in case anyone wants to keep ert installed there	2011-03-01 10:01:40 -07:00
org-test-ob-consts.el	ob-exp: fixed export when headings have links, with tests	2010-10-05 11:54:48 -06:00
org-test.el	Replace org-mode-p with usual (eq major-mode 'org-mode) check	2011-10-22 11:29:24 +02:00
README.org	construct a table from the output of maxima code block	2011-11-08 13:51:27 -07:00

README.org

Org-mode Testing

To run the tests interactively
To run the tests in batch mode

The following instructions describe how to get started using the Org-mode test framework.

To run the tests interactively

Install the jump.el testing dependency which is included as a git submodule in the org-mode repository. To do so run the following git submodule commands from inside the base of the Org-mode directory (or just execute the following code block).
```
  cd ..
  git submodule init
  git submodule update
```
Load the org-test.el file
```
  (load-file "org-test.el")
```
The org-test-jump command is now bound to M-C-j in all emacs-lisp files. Call this command from any file in the lisp/ directory of the org-mode repository to jump to the related test file in the testing/ directory. Call this functions with a prefix argument, and the corresponding test file will be stubbed out if it doesn't already exist.

Ingest the library-of-babel.org file since some tests require this.

  (org-babel-lob-ingest "../contrib/babel/library-of-babel.org")

Review the ERT documentation
A number of org-mode-specific functions and macros are provided in org-test.el see the ;;; Functions for Writing Tests subsection of that file. Some of these functions make use of example org-mode files located in the examples/ directory.
Functions for loading and running the Org-mode tests are provided in the ;;; Load and Run Tests subsection, the most important of which are
- org-test-load which loads the entire Org-mode test suite
- org-test-current-defun which runs all tests for the current function around point (should be called from inside of an Org-mode elisp file)
- org-test-run-all-tests which runs the entire Org-mode test suite
- also note that the ert command can also be used to run tests

Load and run all tests

  (load-file "org-test.el")
  (org-babel-lob-ingest "../contrib/babel/library-of-babel.org")
  (org-test-load)
  (org-test-run-all-tests)

To run the tests in batch mode

First tangle this file out to your desktop.

  ;; add to the load path
  (add-to-list 'load-path (concat org-dir "/lisp/"))
  (add-to-list 'load-path (concat org-dir "/lisp/testing/"))
  (add-to-list 'load-path (concat org-dir "/lisp/testing/ert/"))
  
  ;; load Org-mode
  (require 'org)
  
  ;; setup the ID locations used in tests
  (require 'org-id)
  (org-id-update-id-locations
   (list (concat org-dir "/testing/examples/babel.org")
         (concat org-dir "/testing/examples/ob-C-test.org")
         (concat org-dir "/testing/examples/normal.org")
         (concat org-dir "/testing/examples/ob-awk-test.org")
         (concat org-dir "/testing/examples/ob-fortran-test.org")
         (concat org-dir "/testing/examples/ob-maxima-test.org")
         (concat org-dir "/testing/examples/link-in-heading.org")
         (concat org-dir "/testing/examples/links.org")))
  
  ;; ensure that the latest Org-mode is loaded
  (org-reload)
  
  ;; load the test suite
  (load-file (concat org-dir "/testing/org-test.el"))
  
  ;; configure Babel
  (org-babel-lob-ingest (concat org-dir "/contrib/babel/library-of-babel.org"))
  (org-babel-do-load-languages
   'org-babel-load-languages
   '((emacs-lisp . t)
     (sh . t)))
  (setq org-confirm-babel-evaluate nil)
  
  ;; run the test suite
  (org-test-run-all-tests)
  
  ;; print the results
  (with-current-buffer "*ert*"
    (print (buffer-string)))

Then run the test suite with the following command which could use any version of Emacs.

  emacs --batch -Q -l ~/Desktop/run-org-tests.el