From a405bc0537cf5836b35a0b59f116ccae3ca761b6 Mon Sep 17 00:00:00 2001 From: Marcello Stanisci Date: Tue, 27 Dec 2016 00:15:05 +0100 Subject: Minor fixes on rendering --- docs/example-essay-store.rst | 73 ++++++++------- docs/exchange-db-generate.sh | 3 + docs/exchange-db.png | Bin 0 -> 198095 bytes docs/global-licensing.rst | 215 +++++++++++++++++++++++++++++++++++++++++++ docs/global_licensing.rst | 215 ------------------------------------------- docs/index.rst | 2 +- docs/releases.rst | 103 +++++++++++++++++++++ docs/versioning.rst | 60 ++++++++++++ 8 files changed, 422 insertions(+), 249 deletions(-) create mode 100755 docs/exchange-db-generate.sh create mode 100644 docs/exchange-db.png create mode 100644 docs/global-licensing.rst delete mode 100644 docs/global_licensing.rst create mode 100644 docs/releases.rst create mode 100644 docs/versioning.rst (limited to 'docs') diff --git a/docs/example-essay-store.rst b/docs/example-essay-store.rst index 8a32aa1d..4687083c 100644 --- a/docs/example-essay-store.rst +++ b/docs/example-essay-store.rst @@ -94,40 +94,47 @@ After the rendering, (part of) ``purchase.html`` will look like shown below. .. sourcecode:: html - ... - - - ... - - - ... - ... - -

- Oops, it looks like you don't have a Taler wallet installed. Why don't you enter - all your credit card details before reading the article? You can also - use GNU Taler to complete the purchase at any time. -

- - - -

+ + + + + + + + + + + + -

- Processing payment with GNU Taler, please wait -

- ... +

+ Oops, it looks like you don't have a Taler wallet installed. Why don't you enter + all your credit card details before reading the article? You can also + use GNU Taler to complete the purchase at any time. +

+ + + +

+ +

+ Processing payment with GNU Taler, please wait +

+ + + + The script ``purchase.js`` is now in charge of implementing the behaviour we seek. It needs to register two handlers: one called whenever the wallet is detected in the diff --git a/docs/exchange-db-generate.sh b/docs/exchange-db-generate.sh new file mode 100755 index 00000000..b296e0c9 --- /dev/null +++ b/docs/exchange-db-generate.sh @@ -0,0 +1,3 @@ +#!/bin/sh +taler-exchange-dbinit -r +java -jar schemaSpy_5.0.0.jar -t pgsql -db taler -o taler -host localhost -dp /usr/share/java/postgresql-jdbc3-9.2.jar -u grothoff -p test -s public -hq diff --git a/docs/exchange-db.png b/docs/exchange-db.png new file mode 100644 index 00000000..ddc25591 Binary files /dev/null and b/docs/exchange-db.png differ diff --git a/docs/global-licensing.rst b/docs/global-licensing.rst new file mode 100644 index 00000000..7a5e8226 --- /dev/null +++ b/docs/global-licensing.rst @@ -0,0 +1,215 @@ +=========================== +Taler licensing information +=========================== + +This file gives an overview of all Taler component's licensing and of +runtime dependencies thereof. For "component" here is meant a set of +source files which can be retrieved from a single repository. If +components consist of sources under different licensing regimes, i.e. +because we want to enable third party developments to easily integrate +with Taler, those are described as well. + +All components are generally released under Lesser GPL, GPL or Affero +GPL. The main strategy is for libraries that third parties may need +to integrate with Taler to be under LGPL, standalone binaries and +testcases to be under GPL, and Web servers implementing Web services +to be under AGPL. + ++++++++++++++++++++++++++ +API (git://taler.net/api) ++++++++++++++++++++++++++ + +The specification has been jointly developed by INRIA and by individuals +being under the juridical subject called 'GNUnet e.V.'. For each source +file, the header indicated whose is holding the copyright, since some +parts have been taken "verbatim" from the GNUnet e.V. foundation, and +some other have been developed at INRIA "ex novo". + +Generally, GNU GPLv3 license is used for them; see COPYING.GPL. + + +-------------------- +Runtime dependencies +-------------------- +This component has no runtime dependencies as it is supposed to generate +HTML. + + +++++++++++++++++++++++++++++++++++++++++++++++++++++++ +Firefox/Android/Python Wallet (git://taler.net/wallet) +++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +This project includes contributions from INRIA and GNUnet +e.V. developers. Please refer to each source file to obtain +information about the copyright holder. The GNU GPLv3 is used as the +license for Wallets. Some components may be under the LGPL. + +-------------------- +Runtime dependencies +-------------------- + +The following list encompasses all the runtime dependencies for this +project, and gives the copyright holder for each of them: + +* libgnunetutil: GPLv3+, GNUnet e.V. +* libgnunetjson: GPLv3+, GNUnet e.V. +* libgcrypt: LGPL, Free Software Foundation +* libunistring: LGPL, Free Software Foundation +* Python: Python Software Foundation License, LGPL-Compatible, Python Software Foundation +* Mozilla Firefox: Mozilla Public License, LGPL-Compatible, Mozilla Foundation + + ++++++++++++++++++++++++++++++++++++++++++++++++++++ +WebExtensions Wallet (git://taler.net/wallet-webex) ++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The TypeScript code was developed 100% at INRIA, but the project +involves compiling libgnunetutil and libtalerutil to JavaScript, and +thus depends on software from GNUnet e.V. + +Each source carries its own copyright holder(s), but it is generally +licensed under GPLv3+. + +-------------------- +Runtime dependencies +-------------------- + +The following list encompasses all the runtime dependencies for this +project, and gives the copyright holder for each of them: + +* libgnunetutil: GPLv3+, GNUnet e.V. +* libgnunetjson: GPLv3+, GNUnet e.V. +* libgcrypt: LGPL, Free Software Foundation +* libunistring: LGPL, Free Software Foundation + +Note that these dependencies are compiled into the extension and do +not appear as separate binary files. + + ++++++++++++++++++++++++++++++++++++ +Merchant (git://taler.net/merchant) ++++++++++++++++++++++++++++++++++++ + +This project contains code under two different licenses, and whose +copyright is held by INRIA and/or GNUnet e.V.. Please refer to each +source file to know which party holds the copyright. + +Source files are located in the following directories: + +* src/lib/ +* src/backend/ +* src/backenddb/ +* src/include/ +* src/tests/ +* examples/blog/ +* examples/shop/ +* copylib/ + +In examples/blog/articles/ we included a book by Richard Stallman. +It comes with its own permissive license (see COPYING in the +directory). + + +The merchant's backend (i.e. all the code in src/backend/) is under +the GNU Affero GPL as it depends on libgnunetutil. Note that the use +of the Affero GPL has little impact as the backend is not supposed to +be directly accessible to the Internet). The license for this code is +in COPYING.GPL and COPYING.AGPL. + +The merchant's frontend logic (i.e. JavaScript interacting with +the wallet, sample code for a shop) is under the GNU LGPL (but +we may choose to change this to be in the public domain or +BSD-licensed if necessary; the code is so short that there is +anyway the question whether it is copyrightable). Under this same +license, it comes the merchant library (src/lib/) as it can be linked +with more diverse licensed software. The license text for this code +is in COPYING.LGPL. + + + +-------------------- +Runtime dependencies +-------------------- + +The following list encompasses all the runtime dependencies for this +project, and gives the copyright holder for each of them: + +* libjansson: MIT License, AGPL- and LGPL-Compatible, owned by Petri Lehtinen and other individuals +* libgcrypt: LGPL, owned by Free Software Foundation +* postgresql: PostgreSQL License, AGPL- and LGPL-Compatible, owned by The PostgreSQL Global Development Group +* libgnunetutil (in all of its variants): GPLv3+, owned by GNUnet e.V. +* PHP: PHP License, AGPL- and LGPL-Compatible, owned by The PHP Group + ++++++++++++++++++++++++++++ +Bank (git://taler.net/bank) ++++++++++++++++++++++++++++ + +--------- +Licensing +--------- + +This project has been developed by INRIA. For each source file, the +header indicated whose is holding the copyright. The licensing plan +for the bank is to use the Affero GPLv3+. + +Source files of interest are located in the following directories: +(The repository holds also scaffolded files autogenerated by Django, +which do not have legal significance in this context.) + +* TalerBank/Bank/ +* TalerBank/Bank/templates/ +* TalerBank/my-static/ +* website/ + +-------------------- +Runtime dependencies +-------------------- + +The following list encompasses all the runtime dependencies for this +project, and gives the copyright holder for each of them: + +* Django: BSD License, AGPL-Compatible, owned by Django Software Foundation +* validictory: BSD License, AGPL-Compatible, owned by James Turk +* django-simple-math-captcha: Apache Software License, LGPL-Compatible (FIXME), Brandon Taylor +* requests: Apache2 License, AGPL-Compatible, owned by Kenneth Reitz +* Python: Python Software Foundation License, AGPL-Compatible, Python Software Foundation +* PHP: PHP License, AGPL-Compatible, owned by The PHP Group + + +.. _exchange-repo: + ++++++++++++++++++++++++++++++++++++ +Exchange (git://taler.net/exchange) ++++++++++++++++++++++++++++++++++++ + +This component is based on code initially developed in Munich for +GNUnet e.V. Most recent improvements and maintenance has been done at +Inria. The copyright is thus shared between both institutions. + +The licensing for exported libraries to access the exchange is LGPL, +the exchange itself is under AGPL, and testcases and standalone +binaries are under GPL. + + +-------------------- +Runtime dependencies +-------------------- + +The following list encompasses all the runtime dependencies for this +project, and gives the copyright holder for each of them: + +* libjansson: MIT License, AGPL- and LGPL-Compatible, owned by Petri Lehtinen and other individuals +* libgcrypt: LGPL, owned by Free Software Foundation +* postgresql: PostgreSQL License, AGPL- and LGPL-Compatible, owned by The PostgreSQL Global Development Group +* libgnunetutil (in all of its variants): GPLv3+, owned by GNUnet e.V. +* libgnunetjson: GPLv3+, GNUnet e.V. + + ++++++++++++++++++++++++++++++++++++++++++ +Web includes (git://taler.net/web-common) ++++++++++++++++++++++++++++++++++++++++++ + +All copyright owned by INRIA (but questionable whether creativity +threshold for copyright is even met). + +Sources are licensed under the GNU LGPL. diff --git a/docs/global_licensing.rst b/docs/global_licensing.rst deleted file mode 100644 index 7a5e8226..00000000 --- a/docs/global_licensing.rst +++ /dev/null @@ -1,215 +0,0 @@ -=========================== -Taler licensing information -=========================== - -This file gives an overview of all Taler component's licensing and of -runtime dependencies thereof. For "component" here is meant a set of -source files which can be retrieved from a single repository. If -components consist of sources under different licensing regimes, i.e. -because we want to enable third party developments to easily integrate -with Taler, those are described as well. - -All components are generally released under Lesser GPL, GPL or Affero -GPL. The main strategy is for libraries that third parties may need -to integrate with Taler to be under LGPL, standalone binaries and -testcases to be under GPL, and Web servers implementing Web services -to be under AGPL. - -+++++++++++++++++++++++++ -API (git://taler.net/api) -+++++++++++++++++++++++++ - -The specification has been jointly developed by INRIA and by individuals -being under the juridical subject called 'GNUnet e.V.'. For each source -file, the header indicated whose is holding the copyright, since some -parts have been taken "verbatim" from the GNUnet e.V. foundation, and -some other have been developed at INRIA "ex novo". - -Generally, GNU GPLv3 license is used for them; see COPYING.GPL. - - --------------------- -Runtime dependencies --------------------- -This component has no runtime dependencies as it is supposed to generate -HTML. - - -++++++++++++++++++++++++++++++++++++++++++++++++++++++ -Firefox/Android/Python Wallet (git://taler.net/wallet) -++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -This project includes contributions from INRIA and GNUnet -e.V. developers. Please refer to each source file to obtain -information about the copyright holder. The GNU GPLv3 is used as the -license for Wallets. Some components may be under the LGPL. - --------------------- -Runtime dependencies --------------------- - -The following list encompasses all the runtime dependencies for this -project, and gives the copyright holder for each of them: - -* libgnunetutil: GPLv3+, GNUnet e.V. -* libgnunetjson: GPLv3+, GNUnet e.V. -* libgcrypt: LGPL, Free Software Foundation -* libunistring: LGPL, Free Software Foundation -* Python: Python Software Foundation License, LGPL-Compatible, Python Software Foundation -* Mozilla Firefox: Mozilla Public License, LGPL-Compatible, Mozilla Foundation - - -+++++++++++++++++++++++++++++++++++++++++++++++++++ -WebExtensions Wallet (git://taler.net/wallet-webex) -+++++++++++++++++++++++++++++++++++++++++++++++++++ - -The TypeScript code was developed 100% at INRIA, but the project -involves compiling libgnunetutil and libtalerutil to JavaScript, and -thus depends on software from GNUnet e.V. - -Each source carries its own copyright holder(s), but it is generally -licensed under GPLv3+. - --------------------- -Runtime dependencies --------------------- - -The following list encompasses all the runtime dependencies for this -project, and gives the copyright holder for each of them: - -* libgnunetutil: GPLv3+, GNUnet e.V. -* libgnunetjson: GPLv3+, GNUnet e.V. -* libgcrypt: LGPL, Free Software Foundation -* libunistring: LGPL, Free Software Foundation - -Note that these dependencies are compiled into the extension and do -not appear as separate binary files. - - -+++++++++++++++++++++++++++++++++++ -Merchant (git://taler.net/merchant) -+++++++++++++++++++++++++++++++++++ - -This project contains code under two different licenses, and whose -copyright is held by INRIA and/or GNUnet e.V.. Please refer to each -source file to know which party holds the copyright. - -Source files are located in the following directories: - -* src/lib/ -* src/backend/ -* src/backenddb/ -* src/include/ -* src/tests/ -* examples/blog/ -* examples/shop/ -* copylib/ - -In examples/blog/articles/ we included a book by Richard Stallman. -It comes with its own permissive license (see COPYING in the -directory). - - -The merchant's backend (i.e. all the code in src/backend/) is under -the GNU Affero GPL as it depends on libgnunetutil. Note that the use -of the Affero GPL has little impact as the backend is not supposed to -be directly accessible to the Internet). The license for this code is -in COPYING.GPL and COPYING.AGPL. - -The merchant's frontend logic (i.e. JavaScript interacting with -the wallet, sample code for a shop) is under the GNU LGPL (but -we may choose to change this to be in the public domain or -BSD-licensed if necessary; the code is so short that there is -anyway the question whether it is copyrightable). Under this same -license, it comes the merchant library (src/lib/) as it can be linked -with more diverse licensed software. The license text for this code -is in COPYING.LGPL. - - - --------------------- -Runtime dependencies --------------------- - -The following list encompasses all the runtime dependencies for this -project, and gives the copyright holder for each of them: - -* libjansson: MIT License, AGPL- and LGPL-Compatible, owned by Petri Lehtinen and other individuals -* libgcrypt: LGPL, owned by Free Software Foundation -* postgresql: PostgreSQL License, AGPL- and LGPL-Compatible, owned by The PostgreSQL Global Development Group -* libgnunetutil (in all of its variants): GPLv3+, owned by GNUnet e.V. -* PHP: PHP License, AGPL- and LGPL-Compatible, owned by The PHP Group - -+++++++++++++++++++++++++++ -Bank (git://taler.net/bank) -+++++++++++++++++++++++++++ - ---------- -Licensing ---------- - -This project has been developed by INRIA. For each source file, the -header indicated whose is holding the copyright. The licensing plan -for the bank is to use the Affero GPLv3+. - -Source files of interest are located in the following directories: -(The repository holds also scaffolded files autogenerated by Django, -which do not have legal significance in this context.) - -* TalerBank/Bank/ -* TalerBank/Bank/templates/ -* TalerBank/my-static/ -* website/ - --------------------- -Runtime dependencies --------------------- - -The following list encompasses all the runtime dependencies for this -project, and gives the copyright holder for each of them: - -* Django: BSD License, AGPL-Compatible, owned by Django Software Foundation -* validictory: BSD License, AGPL-Compatible, owned by James Turk -* django-simple-math-captcha: Apache Software License, LGPL-Compatible (FIXME), Brandon Taylor -* requests: Apache2 License, AGPL-Compatible, owned by Kenneth Reitz -* Python: Python Software Foundation License, AGPL-Compatible, Python Software Foundation -* PHP: PHP License, AGPL-Compatible, owned by The PHP Group - - -.. _exchange-repo: - -+++++++++++++++++++++++++++++++++++ -Exchange (git://taler.net/exchange) -+++++++++++++++++++++++++++++++++++ - -This component is based on code initially developed in Munich for -GNUnet e.V. Most recent improvements and maintenance has been done at -Inria. The copyright is thus shared between both institutions. - -The licensing for exported libraries to access the exchange is LGPL, -the exchange itself is under AGPL, and testcases and standalone -binaries are under GPL. - - --------------------- -Runtime dependencies --------------------- - -The following list encompasses all the runtime dependencies for this -project, and gives the copyright holder for each of them: - -* libjansson: MIT License, AGPL- and LGPL-Compatible, owned by Petri Lehtinen and other individuals -* libgcrypt: LGPL, owned by Free Software Foundation -* postgresql: PostgreSQL License, AGPL- and LGPL-Compatible, owned by The PostgreSQL Global Development Group -* libgnunetutil (in all of its variants): GPLv3+, owned by GNUnet e.V. -* libgnunetjson: GPLv3+, GNUnet e.V. - - -+++++++++++++++++++++++++++++++++++++++++ -Web includes (git://taler.net/web-common) -+++++++++++++++++++++++++++++++++++++++++ - -All copyright owned by INRIA (but questionable whether creativity -threshold for copyright is even met). - -Sources are licensed under the GNU LGPL. diff --git a/docs/index.rst b/docs/index.rst index a4982149..b577ad03 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -51,7 +51,7 @@ It focuses on how to install, configure and run the required software. .. toctree:: :maxdepth: 2 - global_licensing + global-licensing configuration-basics operate-exchange operate-merchant diff --git a/docs/releases.rst b/docs/releases.rst new file mode 100644 index 00000000..d0191ba0 --- /dev/null +++ b/docs/releases.rst @@ -0,0 +1,103 @@ +.. + This file is part of GNU TALER. + Copyright (C) 2016 INRIA + TALER is free software; you can redistribute it and/or modify it under the + terms of the GNU General Public License as published by the Free Software + Foundation; either version 2.1, or (at your option) any later version. + TALER is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + You should have received a copy of the GNU Lesser General Public License along with + TALER; see the file COPYING. If not, see + + @author Florian Dold + + +============================== +Release Process and Checklists +============================== + +This document describes the process for releasing a new version of the various +Taler components to the official GNU mirrors. + +The following components are published on the GNU mirrors + +* taler-exchange (exchange.git) +* taler-merchant (merchant.git) +* talerfrontends (merchant-frontends.git) +* taler-bank (bank.git) +* taler-wallet-webex (wallet-webex.git) + + +------- +Tagging +------- + +Tag releases with an *annotated* commit, like + +:: + + git tag -a v0.1.0 -m "Official release v0.1.0" + git push origin v0.1.0 + +------------------ +Database for tests +------------------ + +For tests in the exchange and merchant to run, make sure that +a database `talertest` is accessible by `$USER`. Otherwise tests +involving the database logic are skipped. + +------------------ +Exchange, merchant +------------------ + +Set the version in `configure.ac`. The commit being tagged +should be the change of the version. + +For the exchange test cases to pass, `make install` must be run first. +Without it, test cases will fail because plugins can't be located. + +:: + + ./bootstrap + ./configure # add required options for your system + make dist + tar -xf taler-$COMPONENT-$VERSION.tar.gz + cd taler-$COMPONENT-$VERSION + make install check + +-------------------- +Wallet WebExtension +-------------------- + +The version of the wallet is in `manifest.json`. The `version_name` should be +adjusted, and `version` should be increased independently on every upload to +the WebStore. + +:: + + ./configure + make dist + + + +FIXME: selenium test cases + + +---------------------- +Upload to GNU mirrors +---------------------- + +See https://www.gnu.org/prep/maintain/maintain.html#Automated-FTP-Uploads + +Directive file: + +:: + + version: 1.2 + directory: taler + filename: taler-exchange-0.1.0.tar.gz + + +Upload the files in *binary mode* to the ftp servers. diff --git a/docs/versioning.rst b/docs/versioning.rst new file mode 100644 index 00000000..14336da0 --- /dev/null +++ b/docs/versioning.rst @@ -0,0 +1,60 @@ +.. + This file is part of GNU TALER. + Copyright (C) 2014, 2015, 2016 INRIA + + TALER is free software; you can redistribute it and/or modify it under the + terms of the GNU General Public License as published by the Free Software + Foundation; either version 2.1, or (at your option) any later version. + + TALER is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + You should have received a copy of the GNU Lesser General Public License along with + TALER; see the file COPYING. If not, see + + @author Christian Grothoff + +================== +GNU Taler Versions +================== + +This text describes how we assign version numbers for Taler software. +This is about the version numbers of package releases, not of the +libraries. For Taler libraries, we use libtool semantic versioning +conventions. + +Taler software release version numbers use the scheme +MAJOR.MINOR-PACKAGE. + +Here, MAJOR is used to indicate the compatibility level and is +increased for all significant releases that are always made across all +Taler components. + +The MINOR numbers is used for small updates that may address minor +issues but do not break compatibility. MINOR release may be made only +for a particular component, leaving other components untouched. Hence +you should expect to see say an exchange version 4.5 and a wallet +version 4.10. As they both start with "4", they are expected to be +protocol-compatible. + +PACKAGE is reserved for distributions, such as Debian. These distributions +may apply their own patch sets or scripting, and they are expected to +increment PACKAGE. The upstream Taler releases will just be of the +format MAJOR.MINOR. + +----------------------- +Alpha and Beta releases +----------------------- + +Before Taler is considered reasonably stable for actual use, we will +prefix the number "0." to the release version. Thus, all alpha and +beta releases will have a three-digit release number of the form +"0.MAJOR.MINOR". + +----------------------- +Roadmap +----------------------- + +A roadmap with the features we plan to have in each release is +in our bugtracker at https://gnunet.org/bugs/. The roadmap +is subject to change. -- cgit v1.2.3