From f2784197c71502989ca108d1b19444180fbea216 Mon Sep 17 00:00:00 2001 From: Mike Hearn Date: Wed, 5 Sep 2018 13:22:56 +0200 Subject: [PATCH] Minor: fix old warning in Corda 1.0 docs, don't recommend use of Jigsaw yet. --- docs/source/corda-api.rst | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/docs/source/corda-api.rst b/docs/source/corda-api.rst index 9e79e9d8a7..84c243173b 100644 --- a/docs/source/corda-api.rst +++ b/docs/source/corda-api.rst @@ -26,21 +26,8 @@ Before reading this page, you should be familiar with the :doc:`key concepts of Internal APIs and stability guarantees -------------------------------------- -.. warning:: For Corda 1.0 we do not currently provide a stable wire protocol or support for database upgrades. - Additionally, the JSON format produced by the client-jackson module may change in future. - Therefore, you should not expect to be able to migrate persisted data from 1.0 to future versions. - - Additionally, it may be necessary to recompile applications against future versions of the API until we begin offering - ABI stability as well. We plan to do this soon after the release of Corda 1.0. - - Finally, please note that the 1.0 release has not yet been security audited. You should not run it in situations - where security is required. - -Corda artifacts can be required from Java 9 Jigsaw modules. -From within a ``module-info.java``, you can reference one of the modules e.g., ``requires net.corda.core;``. - -.. warning:: while Corda artifacts can be required from ``module-info.java`` files, they are still not proper Jigsaw modules, - because they rely on the automatic module mechanism and declare no module descriptors themselves. We plan to integrate Jigsaw more thoroughly in the future. +Corda makes certain commitments about what parts of the API will preserve backwards compatibility as they change and +which will not. Over time, more of the API will fall under the stability guarantees. Corda stable modules --------------------