docs: fix non generated headers (#571)

Consensys · Dec 10, 2024 · 47c09c6 · 47c09c6
1 parent 19b6b55
commit 47c09c6
Show file tree

Hide file tree

Showing 1,178 changed files with 1,720 additions and 2,944 deletions.
diff --git a/.chglog/config.yml b/.chglog/config.yml
@@ -2,7 +2,7 @@ style: github
 template: CHANGELOG.tpl.md
 info:
   title: CHANGELOG
-  repository_url: https://github.com/ConsenSys/gnark-crypto
+  repository_url: https://github.com/Consensys/gnark-crypto
 options:
   commits:
     # filters:

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CITATION.bib b/CITATION.bib
@@ -4,7 +4,7 @@ @software{gnark-crypto-v0.7
                   Youssef El Housni and
                   Arya Tabaie and
                   Ivo Kubjas},
-  title        = {ConsenSys/gnark-crypto: v0.7.0},
+  title        = {Consensys/gnark-crypto: v0.7.0},
   month        = jan,
   year         = 2022,
   publisher    = {Zenodo},

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # gnark-crypto
 
-[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/gnark_team.svg?style=social&label=Follow%20%40gnark_team)](https://twitter.com/gnark_team) [![License](https://img.shields.io/badge/license-Apache%202-blue)](LICENSE)  [![Go Report Card](https://goreportcard.com/badge/github.com/ConsenSys/gnark-crypto)](https://goreportcard.com/badge/github.com/ConsenSys/gnark-crypto) [![PkgGoDev](https://pkg.go.dev/badge/mod/github.com/consensys/gnark-crypto)](https://pkg.go.dev/mod/github.com/consensys/gnark-crypto) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5815453.svg)](https://doi.org/10.5281/zenodo.5815453)
+[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/gnark_team.svg?style=social&label=Follow%20%40gnark_team)](https://twitter.com/gnark_team) [![License](https://img.shields.io/badge/license-Apache%202-blue)](LICENSE)  [![Go Report Card](https://goreportcard.com/badge/github.com/Consensys/gnark-crypto)](https://goreportcard.com/badge/github.com/Consensys/gnark-crypto) [![PkgGoDev](https://pkg.go.dev/badge/mod/github.com/Consensys/gnark-crypto)](https://pkg.go.dev/mod/github.com/Consensys/gnark-crypto) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5815453.svg)](https://doi.org/10.5281/zenodo.5815453)
 
 `gnark-crypto` provides efficient cryptographic primitives, in Go:
 
@@ -23,19 +23,19 @@
 
 `gnark-crypto` is actively developed and maintained by the team ([email protected] | [HackMD](https://hackmd.io/@gnark)) behind:
 
-* [`gnark`: a framework to execute (and verify) algorithms in zero-knowledge](https://github.com/consensys/gnark)
+* [`gnark`: a framework to execute (and verify) algorithms in zero-knowledge](https://github.com/Consensys/gnark)
 
 ## Warning
 
 **`gnark-crypto` is not fully audited and is provided as-is, use at your own risk. In particular, `gnark-crypto` makes no security guarantees such as constant time implementation or side-channel attack resistance.**
 
-**To report a security bug, please refer to [`gnark` Security Policy](https://github.com/ConsenSys/gnark/blob/master/SECURITY.md).**
+**To report a security bug, please refer to [`gnark` Security Policy](https://github.com/Consensys/gnark/blob/master/SECURITY.md).**
 
 `gnark-crypto` packages are optimized for 64bits architectures (x86 `amd64`) and tested on Unix (Linux / macOS).
 
 ## Audits
 
-See [list of audits for `gnark` and `gnark-crypto`](https://github.com/consensys/gnark?tab=readme-ov-file#audits)
+See [list of audits for `gnark` and `gnark-crypto`](https://github.com/Consensys/gnark?tab=readme-ov-file#audits)
 
 ## Getting started
 
@@ -46,7 +46,7 @@ See [list of audits for `gnark` and `gnark-crypto`](https://github.com/consensys
 ### Install `gnark-crypto`
 
 ```bash
-go get github.com/consensys/gnark-crypto
+go get github.com/Consensys/gnark-crypto
 ```
 
 Note that if you use go modules, in `go.mod` the module path is case sensitive (use `consensys` and not `ConsenSys`).
@@ -97,26 +97,26 @@ Please use the following BibTeX to cite the most recent release.
 
 ## Versioning
 
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/consensys/gnark-crypto/tags).
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/Consensys/gnark-crypto/tags).
 
 ## License
 
 This project is licensed under the Apache 2 License - see the [LICENSE](LICENSE) file for details.
 
-[`field/goff`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/field/goff
-[`bn254`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254
-[`bls12-381`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bls12-381
-[`bls24-317`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bls24-317
-[`bls12-377`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bls12-377
-[`bls24-315`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bls24-315
-[`bw6-761`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bw6-761
-[`bw6-633`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bw6-633
-[`twistededwards`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/twistededwards
-[`eddsa`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/twistededwards/eddsa
-[`fft`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/fr/fft
-[`fri`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/fr/fri
-[`mimc`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/fr/mimc
-[`kzg`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/fr/kzg
-[`plookup`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/fr/plookup
-[`permutation`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/fr/permutation
-[`fiatshamir`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/fiat-shamir
+[`field/goff`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/field/goff
+[`bn254`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254
+[`bls12-381`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bls12-381
+[`bls24-317`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bls24-317
+[`bls12-377`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bls12-377
+[`bls24-315`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bls24-315
+[`bw6-761`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bw6-761
+[`bw6-633`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bw6-633
+[`twistededwards`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/twistededwards
+[`eddsa`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/twistededwards/eddsa
+[`fft`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/fr/fft
+[`fri`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/fr/fri
+[`mimc`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/fr/mimc
+[`kzg`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/fr/kzg
+[`plookup`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/fr/plookup
+[`permutation`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/fr/permutation
+[`fiatshamir`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/fiat-shamir
diff --git a/ecc/bls12-377/ecdsa/doc.go b/ecc/bls12-377/ecdsa/doc.go
diff --git a/ecc/bls12-377/ecdsa/ecdsa.go b/ecc/bls12-377/ecdsa/ecdsa.go
diff --git a/ecc/bls12-377/ecdsa/ecdsa_test.go b/ecc/bls12-377/ecdsa/ecdsa_test.go
diff --git a/ecc/bls12-377/ecdsa/marshal.go b/ecc/bls12-377/ecdsa/marshal.go
diff --git a/ecc/bls12-377/ecdsa/marshal_test.go b/ecc/bls12-377/ecdsa/marshal_test.go
diff --git a/ecc/bls12-377/fflonk/doc.go b/ecc/bls12-377/fflonk/doc.go
diff --git a/ecc/bls12-377/fflonk/example_test.go b/ecc/bls12-377/fflonk/example_test.go
diff --git a/ecc/bls12-377/fflonk/fflonk.go b/ecc/bls12-377/fflonk/fflonk.go
diff --git a/ecc/bls12-377/fflonk/fflonk_test.go b/ecc/bls12-377/fflonk/fflonk_test.go
diff --git a/ecc/bls12-377/fflonk/marshal.go b/ecc/bls12-377/fflonk/marshal.go
diff --git a/ecc/bls12-377/fp/arith.go b/ecc/bls12-377/fp/arith.go
diff --git a/ecc/bls12-377/fp/asm_adx.go b/ecc/bls12-377/fp/asm_adx.go
diff --git a/ecc/bls12-377/fp/asm_noadx.go b/ecc/bls12-377/fp/asm_noadx.go
diff --git a/ecc/bls12-377/fp/doc.go b/ecc/bls12-377/fp/doc.go
diff --git a/ecc/bls12-377/fp/element.go b/ecc/bls12-377/fp/element.go
diff --git a/ecc/bls12-377/fp/element_amd64.go b/ecc/bls12-377/fp/element_amd64.go
diff --git a/ecc/bls12-377/fp/element_amd64.s b/ecc/bls12-377/fp/element_amd64.s
@@ -1,10 +1,10 @@
 //go:build  !purego
 
-// Copyright 2020 Consensys Software Inc.
+// Copyright 2020-2024 Consensys Software Inc.
 // Licensed under the Apache License, Version 2.0. See the LICENSE file for details.
 
 // Code generated by consensys/gnark-crypto DO NOT EDIT
 
-// We include the hash to force the Go compiler to recompile: 11124594824487954849
+// We include the hash to force the Go compiler to recompile: 18408829383245254329
 #include "../../../field/asm/element_6w_amd64.s"
 
diff --git a/ecc/bls12-377/fp/element_arm64.go b/ecc/bls12-377/fp/element_arm64.go
diff --git a/ecc/bls12-377/fp/element_arm64.s b/ecc/bls12-377/fp/element_arm64.s
@@ -1,6 +1,6 @@
 //go:build  !purego
 
-// Copyright 2020 Consensys Software Inc.
+// Copyright 2020-2024 Consensys Software Inc.
 // Licensed under the Apache License, Version 2.0. See the LICENSE file for details.
 
 // Code generated by consensys/gnark-crypto DO NOT EDIT

diff --git a/ecc/bls12-377/fp/element_exp.go b/ecc/bls12-377/fp/element_exp.go
diff --git a/ecc/bls12-377/fp/element_purego.go b/ecc/bls12-377/fp/element_purego.go
diff --git a/ecc/bls12-377/fp/element_test.go b/ecc/bls12-377/fp/element_test.go
diff --git a/ecc/bls12-377/fp/element_utils.go b/ecc/bls12-377/fp/element_utils.go
@@ -1,16 +1,5 @@
-// Copyright 2020 ConsenSys Software Inc.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
+// Copyright 2020-2024 Consensys Software Inc.
+// Licensed under the Apache License, Version 2.0. See the LICENSE file for details.
 
 package fp
 

diff --git a/ecc/bls12-377/fp/hash_to_field/doc.go b/ecc/bls12-377/fp/hash_to_field/doc.go
diff --git a/ecc/bls12-377/fp/hash_to_field/hash_to_field.go b/ecc/bls12-377/fp/hash_to_field/hash_to_field.go
diff --git a/ecc/bls12-377/fp/hash_to_field/hash_to_field_test.go b/ecc/bls12-377/fp/hash_to_field/hash_to_field_test.go
diff --git a/ecc/bls12-377/fp/vector.go b/ecc/bls12-377/fp/vector.go
diff --git a/ecc/bls12-377/fp/vector_purego.go b/ecc/bls12-377/fp/vector_purego.go
diff --git a/ecc/bls12-377/fp/vector_test.go b/ecc/bls12-377/fp/vector_test.go
diff --git a/ecc/bls12-377/fr/arith.go b/ecc/bls12-377/fr/arith.go
diff --git a/ecc/bls12-377/fr/asm_adx.go b/ecc/bls12-377/fr/asm_adx.go
diff --git a/ecc/bls12-377/fr/asm_avx.go b/ecc/bls12-377/fr/asm_avx.go
diff --git a/ecc/bls12-377/fr/asm_noadx.go b/ecc/bls12-377/fr/asm_noadx.go
diff --git a/ecc/bls12-377/fr/asm_noavx.go b/ecc/bls12-377/fr/asm_noavx.go
diff --git a/ecc/bls12-377/fr/doc.go b/ecc/bls12-377/fr/doc.go
diff --git a/ecc/bls12-377/fr/element.go b/ecc/bls12-377/fr/element.go
diff --git a/ecc/bls12-377/fr/element_amd64.go b/ecc/bls12-377/fr/element_amd64.go
diff --git a/ecc/bls12-377/fr/element_amd64.s b/ecc/bls12-377/fr/element_amd64.s
@@ -1,10 +1,10 @@
 //go:build  !purego
 
-// Copyright 2020 Consensys Software Inc.
+// Copyright 2020-2024 Consensys Software Inc.
 // Licensed under the Apache License, Version 2.0. See the LICENSE file for details.
 
 // Code generated by consensys/gnark-crypto DO NOT EDIT
 
-// We include the hash to force the Go compiler to recompile: 9425145785761608449
+// We include the hash to force the Go compiler to recompile: 14652627197992229521
 #include "../../../field/asm/element_4w_amd64.s"
 
diff --git a/ecc/bls12-377/fr/element_arm64.go b/ecc/bls12-377/fr/element_arm64.go
diff --git a/ecc/bls12-377/fr/element_arm64.s b/ecc/bls12-377/fr/element_arm64.s
@@ -1,6 +1,6 @@
 //go:build  !purego
 
-// Copyright 2020 Consensys Software Inc.
+// Copyright 2020-2024 Consensys Software Inc.
 // Licensed under the Apache License, Version 2.0. See the LICENSE file for details.
 
 // Code generated by consensys/gnark-crypto DO NOT EDIT