Skip to content

Commit 0a945bc

Browse files
SteveLauCSteveLauC
committed
chore: one changelog for each PR
1 parent e7c877a commit 0a945bc

16 files changed

+73
-11
lines changed

‎CHANGELOG.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
# Change Log
2-
31
All notable changes to this project will be documented in this file.
42
This project adheres to [Semantic Versioning](https://semver.org/).
53

6-
## [Unreleased] - ReleaseDate
4+
# Change Log
75

86
### Fixed
97
- Fix `SigSet` incorrect implementation of `Eq`, `PartialEq` and `Hash`

‎CONTRIBUTING.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,30 @@ pull' model described there.
6161
Please make pull requests against the `master` branch.
6262

6363
If you change the API by way of adding, removing or changing something or if
64-
you fix a bug, please add an appropriate note to the [change log][cl]. We
65-
follow the conventions of [Keep A CHANGELOG][kacl].
64+
you fix a bug, please add an appropriate note, every note should be a new markdown
65+
file under the [changelog directory][cl] stating the change made by your pull request,
66+
the filename should be in the following foramt:
6667

67-
[cl]: https://github.com/nix-rust/nix/blob/master/CHANGELOG.md
68-
[kacl]: https://github.com/olivierlacan/keep-a-changelog/tree/18adb5f5be7a898d046f6a4acb93e39dcf40c4ad
68+
```
69+
<PULL_REQUEST_ID>.<TYPE>.md
70+
```
71+
72+
These are 4 `TYPE`s available:
73+
74+
1. `added`
75+
2. `changed`
76+
3. `fixed`
77+
4. `removed`
78+
79+
Let's say you have added a new API to nix, then a change log like this should
80+
be added (assume it is PR #0)
81+
82+
```md
83+
# file: 0.added.md
84+
Added a new API xxx
85+
```
86+
87+
[cl]: https://github.com/nix-rust/nix/tree/master/changelog
6988
[pr-docs]: https://help.github.com/articles/using-pull-requests/
7089

7190
## Testing

‎changelog/1946.fixed.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix `SigSet` incorrect implementation of `Eq`, `PartialEq` and `Hash`

‎changelog/2074.added.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Added `Ipv6HopLimit` to `::nix::sys::socket::ControlMessage` for Linux,
2+
MacOS, FreeBSD, DragonflyBSD, Android, iOS and Haiku.

‎changelog/2103.added.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Added `Icmp` and `IcmpV6` to `SockProtocol`

‎changelog/2119.changed.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Simplified the function signatures of `recvmmsg` and `sendmmsg`

‎changelog/2119.fixed.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fixed the function signature of `recvmmsg`, potentially causing UB

‎changelog/2134.changed.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
`PollFd::new` now takes a `BorrowedFd` argument, with relaxed lifetime
2+
requirements relative to the previous version.

‎changelog/2136.changed.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
`FdSet::{insert, remove, contains}` now take `BorrowedFd` arguments, and have
2+
relaxed lifetime requirements relative to 0.27.1.

‎changelog/2137.changed.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
The following APIs now take an implementation of `AsFd` rather than a
2+
`RawFd`:
3+
4+
- `unistd::tcgetpgrp`
5+
- `unistd::tcsetpgrp`
6+
- `unistd::fpathconf`
7+
- `unistd::ttyname`
8+
- `unistd::getpeereid`

‎changelog/2139.changed.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Changed `openat()` and `Dir::openat()`, now take optional `dirfd`s

‎changelog/2141.fixed.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix `SignalFd::set_mask`. In 0.27.0 it would actually close the file descriptor.

‎changelog/2142.added.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Added `F_GETPATH` FcntlFlags entry on Apple/NetBSD/DragonflyBSD for `::nix::fcntl`.

‎changelog/2144.changed.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
The MSRV is now 1.69

‎release.toml

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎towncrier.toml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# towncrier configuration document:
2+
# https://towncrier.readthedocs.io/en/stable/configuration.html
3+
4+
[tool.towncrier]
5+
# Read news fragments from this directory
6+
directory = "changelog"
7+
# Concatenate fragments, and prepend to this file
8+
filename = "CHANGELOG.md"
9+
title_format = "## [{version}] - {project_date}"
10+
# Used to disable towncrier's "=====" title header
11+
underlines = ["", "", ""]
12+
# Wrap news fragments to a line length of 79
13+
wrap = true
14+
# Every news fragement under the `changelog` directory is named "<id>.<type>.md",
15+
# this `id` field, is called issue/ticket number in towncrier's term
16+
# `issue_format` controls how this will be rendered in the final CHANGELOG
17+
# We use this for Pull Request even though it is called "issue"
18+
issue_format = "[#{issue}](https://github.com/nix-rust/nix/pull/{issue})"
19+
# Ask towncrier to add new notes after this
20+
start_string = "# Change Log\n"
21+
22+
# nix's change log typs (in alphabetical order)
23+
# These types will be capitalized default.
24+
[tool.towncrier.fragment.added]
25+
[tool.towncrier.fragment.changed]
26+
[tool.towncrier.fragment.fixed]
27+
[tool.towncrier.fragment.removed]

0 commit comments

Comments
 (0)