Skip to content

Commit be08ba2

Browse files
ToruNiinaToruNiina
committed
doc: update versions in docs
1 parent 587f9ac commit be08ba2

File tree

10 files changed

+136
-12
lines changed

10 files changed

+136
-12
lines changed

‎README.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ include(FetchContent)
126126
FetchContent_Declare(
127127
toml11
128128
GIT_REPOSITORY https://github.com/ToruNiina/toml11.git
129-
GIT_TAG v4.3.0
129+
GIT_TAG v4.4.0
130130
)
131131
FetchContent_MakeAvailable(toml11)
132132
@@ -141,15 +141,17 @@ After [adding cpm to your project](https://github.com/cpm-cmake/CPM.cmake?tab=re
141141
```cmake
142142
include(cmake/CPM.cmake)
143143
144-
CPMAddPackage("gh:ToruNiina/toml11@4.3.0")
144+
CPMAddPackage("gh:ToruNiina/toml11@4.4.0")
145145
146146
# OR
147147
148148
CPMAddPackage(
149149
NAME toml11
150150
GITHUB_REPOSITORY "ToruNiina/toml11"
151-
VERSION 4.3.0
152-
OPTIONS "TOML11_PRECOMPILE ON" # to pre-compile
151+
VERSION 4.4.0
152+
OPTIONS
153+
"TOML11_PRECOMPILE ON" # to pre-compile
154+
"TOML11_ENABLE_ACCESS_CHECK ON" # to use value.accessed()
153155
)
154156
155157
add_executable(main main.cpp)

‎README_ja.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ include(FetchContent)
127127
FetchContent_Declare(
128128
toml11
129129
GIT_REPOSITORY https://github.com/ToruNiina/toml11.git
130-
GIT_TAG v4.3.0
130+
GIT_TAG v4.4.0
131131
)
132132
FetchContent_MakeAvailable(toml11)
133133
@@ -142,15 +142,17 @@ target_link_libraries(main PRIVATE toml11::toml11)
142142
```cmake
143143
include(cmake/CPM.cmake)
144144
145-
CPMAddPackage("gh:ToruNiina/toml11@4.3.0")
145+
CPMAddPackage("gh:ToruNiina/toml11@4.4.0")
146146
147147
# OR
148148
149149
CPMAddPackage(
150150
NAME toml11
151151
GITHUB_REPOSITORY "ToruNiina/toml11"
152-
VERSION 4.3.0
153-
OPTIONS "TOML11_PRECOMPILE ON" # to pre-compile
152+
VERSION 4.4.0
153+
OPTIONS
154+
"TOML11_PRECOMPILE ON" # to pre-compile
155+
"TOML11_ENABLE_ACCESS_CHECK ON" # to use value.accessed()
154156
)
155157
156158
add_executable(main main.cpp)

‎docs/content.en/docs/changelog/_index.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,25 @@ weight = 4
66

77
# Change Log
88

9+
# v4.4.0
10+
11+
## Added
12+
13+
- Add `toml::find_or_default()` (#280) (by Ken Matsui @ken-matsui)
14+
- Add `erase` to `ordered_map` (#282) (#283) (by Sunlight @SunPodder)
15+
- Add `bool basic_value::accessed() const` to detect whether the value has been accessed
16+
- enabled only if `TOML11_ENABLE_ACCESS_CHECK` is defined
17+
- Add compare operators to `toml::spec`
18+
19+
## Fixed
20+
21+
- Use `is_void<T>` instead of `is_same<T, void>` (#281) (by Ken Matsui @ken-matsui)
22+
23+
## Changed
24+
25+
- Improve `toml::parse` performance by 2x
26+
- Stop using deprecated Ubuntu 20 image on GitHub Actions
27+
928
# v4.3.0
1029

1130
## Added

‎docs/content.en/docs/features/toml_spec.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ If not specified explicitly, `toml::spec::default_version()` is used to construc
3838

3939
The default value depends on the version of toml11 and follows the latest version of the TOML language released at that time.
4040

41-
As of v4.0.0, TOML v1.1.0 has not been released yet, so the default TOML version is v1.0.0.
41+
As of v4.4.0, TOML v1.1.0 has not been released yet, so the default TOML version is v1.0.0.
4242

4343
{{<hint warning>}}
4444

‎docs/content.en/docs/installation/_index.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,47 @@ target_link_libraries(main PUBLIC toml11::toml11)
2727

2828
toml11 will only run tests and install when it is the root project.
2929

30+
### CMake `FetchContent`
31+
32+
Using `FetchContent`, you can automatically download toml11 to your `build` directory.
33+
34+
```cmake
35+
include(FetchContent)
36+
FetchContent_Declare(
37+
toml11
38+
GIT_REPOSITORY https://github.com/ToruNiina/toml11.git
39+
GIT_TAG v4.4.0
40+
)
41+
FetchContent_MakeAvailable(toml11)
42+
43+
add_executable(main main.cpp)
44+
target_link_libraries(main PRIVATE toml11::toml11)
45+
```
46+
47+
### CMake Package Manager (CPM)
48+
49+
After [adding cpm to your project](https://github.com/cpm-cmake/CPM.cmake?tab=readme-ov-file#adding-cpm), you can use toml11 by doing:
50+
51+
```cmake
52+
include(cmake/CPM.cmake)
53+
54+
CPMAddPackage("gh:ToruNiina/toml11@4.4.0")
55+
56+
# OR
57+
58+
CPMAddPackage(
59+
NAME toml11
60+
GITHUB_REPOSITORY "ToruNiina/toml11"
61+
VERSION 4.4.0
62+
OPTIONS
63+
"TOML11_PRECOMPILE ON" # to pre-compile
64+
"TOML11_ENABLE_ACCESS_CHECK ON" # to use value.accessed()
65+
)
66+
67+
add_executable(main main.cpp)
68+
target_link_libraries(main PUBLIC toml11::toml11)
69+
```
70+
3071
## Installing using cmake
3172

3273
After cloning toml11, you can install it using cmake.

‎docs/content.en/docs/reference/spec.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Constructs a `spec` with the default version.
131131

132132
Used as the default value for `toml::parse` and `toml::format`.
133133

134-
In toml11 v4.0.0, the value is v1.0.0.
134+
In toml11 v4.4.0, the value is v1.0.0.
135135

136136
### `v(major, minor, patch)`
137137

‎docs/content.ja/docs/changelog/_index.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,25 @@ weight = 4
66

77
# Change Log
88

9+
# v4.4.0
10+
11+
## Added
12+
13+
- `toml::find_or_default()` を追加 (by Ken Matsui @ken-matsui)
14+
- `ordered_map`から値を削除できるよう変更 (by Sunlight @SunPodder)
15+
- 値がアクセス済みかを調べる`bool basic_value::accessed() const`を追加
16+
- `TOML11_ENABLE_ACCESS_CHECK`が定義されているときのみ有効
17+
- `toml::spec`に比較演算子を追加
18+
19+
## Fixed
20+
21+
- `is_same<T, void>`ではなく`is_void`を使用するように修正 (by Ken Matsui @ken-matsui)
22+
23+
## Changed
24+
25+
- `toml::parse`のパフォーマンスを約2倍向上
26+
- GitHub ActionsでUbuntu 20のイメージの使用を終了
27+
928
# v4.3.0
1029

1130
## Added

‎docs/content.ja/docs/features/toml_spec.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ int main()
4242

4343
デフォルトの値はtoml11のバージョンによって変わりますが、その時点でリリースされているTOML言語の最新バージョンに追従します。
4444

45-
v4.0.0現在、TOML v1.1.0はまだリリースされていないため、デフォルトのTOMLバージョンはv1.0.0です。
45+
v4.4.0現在、TOML v1.1.0はまだリリースされていないため、デフォルトのTOMLバージョンはv1.0.0です。
4646

4747
{{<hint warning>}}
4848

‎docs/content.ja/docs/installation/_index.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,47 @@ target_link_libraries(main PUBLIC toml11::toml11)
2727

2828
`toml11`は自身がルートプロジェクトのときのみ、テストとインストールを行います。
2929

30+
### CMake `FetchContent`
31+
32+
CMakeの `FetchContent`を使用することで、`build`ディレクトリに自動でダウンロードすることができます。
33+
34+
```cmake
35+
include(FetchContent)
36+
FetchContent_Declare(
37+
toml11
38+
GIT_REPOSITORY https://github.com/ToruNiina/toml11.git
39+
GIT_TAG v4.4.0
40+
)
41+
FetchContent_MakeAvailable(toml11)
42+
43+
add_executable(main main.cpp)
44+
target_link_libraries(main PRIVATE toml11::toml11)
45+
```
46+
47+
### CMake Package Manager (CPM)
48+
49+
[CMake package manager](https://github.com/cpm-cmake/CPM.cmake)を導入すると、以下のようにして使用することができます。
50+
51+
```cmake
52+
include(cmake/CPM.cmake)
53+
54+
CPMAddPackage("gh:ToruNiina/toml11@4.4.0")
55+
56+
# OR
57+
58+
CPMAddPackage(
59+
NAME toml11
60+
GITHUB_REPOSITORY "ToruNiina/toml11"
61+
VERSION 4.4.0
62+
OPTIONS
63+
"TOML11_PRECOMPILE ON" # to pre-compile
64+
"TOML11_ENABLE_ACCESS_CHECK ON" # to use value.accessed()
65+
)
66+
67+
add_executable(main main.cpp)
68+
target_link_libraries(main PUBLIC toml11::toml11)
69+
```
70+
3071
## `cmake`を使用してインストールする
3172

3273
`toml11`をクローンしたのち、`cmake`を使ってインストールすることができます。

‎docs/content.ja/docs/reference/spec.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ constexpr static spec default_version() noexcept;
131131

132132
`toml::parse`、`toml::format`でのデフォルト値として使われます。
133133

134-
toml11 v4.0.0での値は、v1.0.0です。
134+
toml11 v4.4.0での値は、v1.0.0です。
135135

136136
### `v(major, minor, patch)`
137137

0 commit comments

Comments
 (0)