Skip to content

Commit 699dc7b

Browse files
Remove explicit FPC version from docu
Signed-off-by: Marcus Brandenburger <[email protected]>
1 parent a007320 commit 699dc7b

File tree

8 files changed

+14
-17
lines changed

8 files changed

+14
-17
lines changed

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -144,15 +144,11 @@ Additional Google documents provide details on FPC 1.0:
144144

145145
## Releases
146146

147-
- [v1.0-rc1 - Feburary 5, 2021](https://github.com/hyperledger/fabric-private-chaincode/tree/v1.0-rc1)
148-
149-
- [Tech Preview - July 2, 2020](https://github.com/hyperledger/fabric-private-chaincode/tree/concept-release-2.0)
150-
151-
- [Concept Release - March 2, 2020](https://github.com/hyperledger/fabric-private-chaincode/tree/concept-release-1.0)
147+
For all releases go to the [Github Release Page](https://github.com/hyperledger/fabric-private-chaincode/releases).
152148

153149
*WARNING: This project is in continous development and the `main`
154150
branch will not always be stable. Unless you want to actively
155-
contribute to the project itself, we advice you to use one of above releases*
151+
contribute to the project itself, we advise you to use the latest release.*
156152

157153

158154

client_sdk/go/doc.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ SPDX-License-Identifier: Apache-2.0
2121
//
2222
// Usage samples
2323
//
24-
// samples/main.go: Illustrates the use of the FPC Client SDK. The application can be used with our test-network.
25-
// Reference: https://github.com/hyperledger/fabric-private-chaincode/tree/main/integration/test-network
24+
// $FPC_PATH/samples/application: Illustrates the use of the FPC Client SDK.
25+
// The sample applications can be used with our test-network `$FPC_PATH/samples/deployment/test-network`.
2626
//
2727
package fpcclientsdk

client_sdk/go/pkg/client/resmgmt/lifecycleclient.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ SPDX-License-Identifier: Apache-2.0
77
// Package resmgmt provides FPC specific chaincode management functionality.
88
//
99
// For more information on the FPC management commands and related constraints on chaincode versions and endorsement policies,
10-
// see https://github.com/hyperledger/fabric-private-chaincode/blob/main/docs/design/fabric-v2+/fpc-management.md
10+
// see `$FPC_PATH/docs/design/fabric-v2+/fpc-management.md`
1111
//
1212
// Example:
1313
//
@@ -34,7 +34,7 @@ SPDX-License-Identifier: Apache-2.0
3434
// log.Fatal(err)
3535
// }
3636
//
37-
// See also https://github.com/hyperledger/fabric-private-chaincode/blob/main/integration/client_sdk/go/utils.go
37+
// See also `lifecycle_test.go` and `$FPC_PATH/integration/client_sdk/go/utils/utils.go`
3838
// for a running example.
3939
//
4040
package resmgmt

client_sdk/go/pkg/gateway/contract.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import (
1919
// but in addition to the normal FPC operations, it performs FPC specific steps such as encryption/decryption of chaincode requests/responses.
2020
//
2121
// A Contract object is created using the GetContract() factory method.
22-
// For an example of its use, see https://github.com/hyperledger/fabric-private-chaincode/blob/main/client_sdk/go/test/main.go
22+
// For an example of its use, see `contract_test.go`
2323
type Contract interface {
2424
// Name returns the name of the smart contract
2525
Name() string

docs/design/fabric-v2+/interfaces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,4 +438,4 @@ void log_notice(const char* format, ...);
438438
void log_info(const char* format, ...);
439439
void log_debug(const char* format, ...);
440440
```
441-
See https://github.com/hyperledger/fabric-private-chaincode/blob/main/ecc_enclave/enclave/shim.h
441+
See [shim.h](../../../ecc_enclave/enclave/shim.h)

ercc/registry/registry.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ Copyright 2020 Intel Corporation
55
SPDX-License-Identifier: Apache-2.0
66
*/
77

8-
// Package registry defines the client-facing interface of ERCC as defined in the ERCC Interface section in [specifications](https://github.com/hyperledger/fabric-private-chaincode/blob/main/docs/design/fabric-v2%2B/interfaces.md)
8+
// Package registry implements the client-facing interface of ERCC.
9+
// The corresponding specification can be found in the ERCC Interface section in `$FPC_PATH/docs/design/fabric-v2+/interfaces.md`
910
package registry
1011

1112
import (

samples/chaincode/helloworld/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ This tutorial illustrates a simple usecase where a FPC chaincode is used to stor
1616
* Shut down the network
1717

1818
Please refer to [Architecture and
19-
Components](https://github.com/hyperledger/fabric-private-chaincode#architecture-and-components)
19+
Components](../../../README.md#architecture-and-components)
2020
for more details of involved components.
2121

2222
## Prerequisites
23-
This tutorial presumes that you have installed FPC on your `$GOPATH` as described in the FPC [README.md](https://github.com/hyperledger/fabric-private-chaincode/blob/main/README.md#requirements) and `$FPC_PATH` is set accordingly.
23+
This tutorial presumes that you have installed FPC on your `$GOPATH` as described in the FPC [README.md](../../../README.md#requirements) and `$FPC_PATH` is set accordingly.
2424

2525
## Develop chaincode
2626
Go to `$FPC_PATH/samples/chaincode/helloworld` and create a file named `helloworld_cc.cpp` where we will place our chaincode.
@@ -247,7 +247,7 @@ int invoke(
247247
248248
## Build
249249
250-
Make sure you have the [environment variables](https://github.com/hyperledger/fabric-private-chaincode#environment-settings) set. In addition, set `SGX_BUILD=DEBUG` to enable log messages.
250+
Make sure you have the [environment variables](../../../README.md#environment-settings) set. In addition, set `SGX_BUILD=DEBUG` to enable log messages.
251251
252252
To build the helloworld chaincode, we are using CMake. This simplifies the build process and compiles our chaincode using the SGX SDK. Create `CMakeLists.txt` with the following content.
253253

samples/deployment/test-network/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ make build
3232
Note: If you want to build with [mock-enclave](../../../ecc/chaincode/enclave/mock_enclave.go) rather than the real enclave-based one, build with
3333
`make build GOTAGS="-tags mock_ecc"` instead.
3434

35-
Next, setup fabric sample network, binaries and docker images. Here we follow the official Fabric [instructions](https://hyperledger-fabric.readthedocs.io/en/latest/install.html).
35+
Next, setup fabric sample network, binaries and docker images. Here we follow the official Fabric [instructions](https://hyperledger-fabric.readthedocs.io/en/release-2.3/install.html).
3636

3737
```bash
3838
cd $FPC_PATH/samples/deployment/test-network

0 commit comments

Comments
 (0)