mirror of
git://git.sv.gnu.org/emacs.git
synced 2026-01-24 05:22:04 -08:00
100 lines
3.7 KiB
ReStructuredText
100 lines
3.7 KiB
ReStructuredText
.. mode: -*- rst -*-
|
|
|
|
Review checklist
|
|
================
|
|
|
|
:Tag: guide.developer
|
|
:Status: draft documentation
|
|
:Author: Gareth Rees
|
|
:Organization: Ravenbrook Limited
|
|
:Date: 2018-09-18
|
|
:Revision: $Id$
|
|
:Copyright: See section `Copyright and License`_.
|
|
:Index terms: pair: developer; guide
|
|
|
|
|
|
Introduction
|
|
------------
|
|
|
|
_`.intro`: This is an introduction to the Memory Pool System (MPS) for
|
|
new developers.
|
|
|
|
|
|
What to read first
|
|
------------------
|
|
|
|
* `manual/build.txt`_ -- how to build the MPS.
|
|
* `manual/guide`_ -- tutorial for the public interface.
|
|
* `manual/topic`_ -- reference manual for the public interface.
|
|
* `manual/code-index`_ -- description and purpose of each file of source code.
|
|
* design.mps.config_ -- build configuration.
|
|
* design.mps.tests_ -- how to run test cases.
|
|
* design.mps.doc_ -- how to write and edit documentation.
|
|
|
|
.. _manual/build.txt: https://www.ravenbrook.com/project/mps/master/manual/build.txt
|
|
.. _manual/guide: https://www.ravenbrook.com/project/mps/master/manual/html/guide/index.html
|
|
.. _manual/topic: https://www.ravenbrook.com/project/mps/master/manual/html/topic/index.html
|
|
.. _manual/code-index: https://www.ravenbrook.com/project/mps/master/manual/html/code-index.html
|
|
.. _design.mps.config: config
|
|
.. _design.mps.tests: tests
|
|
.. _design.mps.doc: doc
|
|
|
|
|
|
References
|
|
----------
|
|
|
|
.. [APT_2018-09-17]
|
|
"Procedure for new developers";
|
|
Alistair Turnbull; Ravenbrook Limited; 2018-09-17;
|
|
<https://info.ravenbrook.com/mail/2018/09/17/12-36-45/0/>
|
|
|
|
|
|
Document History
|
|
----------------
|
|
|
|
2018-09-18 GDR_ Created based on [APT_2018-09-17]_.
|
|
|
|
.. _GDR: http://www.ravenbrook.com/consultants/gdr/
|
|
|
|
|
|
Copyright and License
|
|
---------------------
|
|
|
|
Copyright © 2015-2018 Ravenbrook Limited <http://www.ravenbrook.com/>.
|
|
All rights reserved. This is an open source license. Contact
|
|
Ravenbrook for commercial licensing options.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are
|
|
met:
|
|
|
|
#. Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
|
|
#. Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in the
|
|
documentation and/or other materials provided with the distribution.
|
|
|
|
#. Redistributions in any form must be accompanied by information on how
|
|
to obtain complete source code for this software and any
|
|
accompanying software that uses this software. The source code must
|
|
either be included in the distribution or be available for no more than
|
|
the cost of distribution plus a nominal fee, and must be freely
|
|
redistributable under reasonable conditions. For an executable file,
|
|
complete source code means the source code for all modules it contains.
|
|
It does not include source code for modules or files that typically
|
|
accompany the major components of the operating system on which the
|
|
executable file runs.
|
|
|
|
**This software is provided by the copyright holders and contributors
|
|
"as is" and any express or implied warranties, including, but not
|
|
limited to, the implied warranties of merchantability, fitness for a
|
|
particular purpose, or non-infringement, are disclaimed. In no event
|
|
shall the copyright holders and contributors be liable for any direct,
|
|
indirect, incidental, special, exemplary, or consequential damages
|
|
(including, but not limited to, procurement of substitute goods or
|
|
services; loss of use, data, or profits; or business interruption)
|
|
however caused and on any theory of liability, whether in contract,
|
|
strict liability, or tort (including negligence or otherwise) arising in
|
|
any way out of the use of this software, even if advised of the
|
|
possibility of such damage.**
|