Skip to content

Commit b09f561

Browse files
committed
Auto merge of #391 - fiveop:changelog, r=posborne
Introduce CHANGELOG.md - Added initial CHANGELOG.md with Changes from Version 0.6.0 and the upcoming changes for version 0.7.0. - Added RELEASE_PROCEDURE.md detailing what changes should be made to CHANGELOG.md during a release. - Added sections about CHANGELOG.md in CONVENTIONS.md and CONTRIBUTIONS.md.
2 parents 9e34676 + 363fc28 commit b09f561

File tree

4 files changed

+119
-1
lines changed

4 files changed

+119
-1
lines changed

CHANGELOG.md

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file.
4+
This project adheres to [Semantic Versioning](http://semver.org/).
5+
6+
## [Unreleased]
7+
8+
### Added
9+
- Added `lseek` and `lseek64` in `::nix::unistd`
10+
([#377](https://github.com/nix-rust/nix/pull/377))
11+
- Added accessors `sigmask_mut` and `sigmask` to `UContext` in
12+
`::nix::ucontext`.
13+
([#370](https://github.com/nix-rust/nix/pull/370))
14+
- Added `WUNTRACED` to `WaitPidFlag` in `::nix::sys::wait` for non-_linux_
15+
targets.
16+
([#379](https://github.com/nix-rust/nix/pull/379))
17+
- Added new module `::nix::sys::reboot` with enumeration `RebootMode` and
18+
functions `reboot` and `set_cad_enabled`. Currently for _linux_ only.
19+
([#386](https://github.com/nix-rust/nix/pull/386))
20+
21+
### Changed
22+
- Replaced the reexported integer constants for signals by the enumeration
23+
`Signal` in `::nix::sys::signal`.
24+
([#362](https://github.com/nix-rust/nix/pull/362))
25+
- Renamed `EventFdFlag` to `EfdFlags` in `::nix::sys::eventfd`.
26+
([#383](https://github.com/nix-rust/nix/pull/383))
27+
28+
### Removed
29+
- Type alias `SigNum` from `::nix::sys::signal`.
30+
([#362](https://github.com/nix-rust/nix/pull/362))
31+
32+
### Fixed
33+
- Fixed the build problem for NetBSD (Note, that we currently do not support
34+
it, so it might already be broken again).
35+
([#389](https://github.com/nix-rust/nix/pull/389))
36+
37+
## [0.6.0] 2016-06-10
38+
39+
### Added
40+
- Added `gettid` in `::nix::unistd` for _linux_ and _android_.
41+
([#293](https://github.com/nix-rust/nix/pull/293))
42+
- Some _mips_ support in `::nix::sched` and `::nix::sys::syscall`.
43+
([#301](https://github.com/nix-rust/nix/pull/301))
44+
- Added `SIGNALFD_SIGINFO_SIZE` in `::nix::sys::signalfd`.
45+
([#309](https://github.com/nix-rust/nix/pull/309))
46+
- Added new module `::nix::ucontext` with struct `UContext`. Currently for
47+
_linux_ only.
48+
([#311](https://github.com/nix-rust/nix/pull/311))
49+
- Added `EPOLLEXCLUSIVE` to `EpollEventKind` in `::nix::sys::epoll`.
50+
([#330](https://github.com/nix-rust/nix/pull/330))
51+
- Added `pause` to `::nix::unistd`.
52+
([#336](https://github.com/nix-rust/nix/pull/336))
53+
- Added `sleep` to `::nix::unistd`.
54+
([#351](https://github.com/nix-rust/nix/pull/351))
55+
- Added `S_IFDIR`, `S_IFLNK`, `S_IFMT` to `SFlag` in `::nix::sys::stat`.
56+
([#359](https://github.com/nix-rust/nix/pull/359))
57+
- Added `clear` and `extend` functions to `SigSet`'s implementation in
58+
`::nix::sys::signal`.
59+
([#347](https://github.com/nix-rust/nix/pull/347))
60+
- `sockaddr_storage_to_addr` in `::nix::sys::socket` now supports `sockaddr_nl`
61+
on _linux_ and _android_.
62+
([#366](https://github.com/nix-rust/nix/pull/366))
63+
- Added support for `SO_ORIGINAL_DST` in `::nix::sys::socket` on _linux_.
64+
([#367](https://github.com/nix-rust/nix/pull/367))
65+
- Added `SIGINFO` in `::nix::sys::signal` for the _macos_ target as well as
66+
`SIGPWR` and `SIGSTKFLT` in `::nix::sys::signal` for non-_macos_ targets.
67+
([#361](https://github.com/nix-rust/nix/pull/361))
68+
69+
### Changed
70+
- Changed the structure `IoVec` in `::nix::sys::uio`.
71+
([#304](https://github.com/nix-rust/nix/pull/304))
72+
- Replaced `CREATE_NEW_FD` by `SIGNALFD_NEW` in `::nix::sys::signalfd`.
73+
([#309](https://github.com/nix-rust/nix/pull/309))
74+
- Renamed `SaFlag` to `SaFlags` and `SigFlag` to `SigFlags` in
75+
`::nix::sys::signal`.
76+
([#314](https://github.com/nix-rust/nix/pull/314))
77+
- Renamed `Fork` to `ForkResult` and changed its fields in `::nix::unistd`.
78+
([#332](https://github.com/nix-rust/nix/pull/332))
79+
- Added the `signal` parameter to `clone`'s signature in `::nix::sched`.
80+
([#344](https://github.com/nix-rust/nix/pull/344))
81+
- `execv`, `execve`, and `execvp` now return `Result<Void>` instead of
82+
`Result<()>` in `::nix::unistd`.
83+
([#357](https://github.com/nix-rust/nix/pull/357))
84+
85+
### Fixed
86+
- Improved the conversion from `std::net::SocketAddr` to `InetAddr` in
87+
`::nix::sys::socket::addr`.
88+
([#335](https://github.com/nix-rust/nix/pull/335))
89+
90+
## [0.5.0] 2016-03-01

CONTRIBUTING.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,13 @@ pull' model described there.
6060

6161
Please make pull requests against the `master` branch.
6262

63-
[pr-docs]: https://help.github.com/articles/using-pull-requests/
63+
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].
6466

67+
[cl]: https://github.com/nix-rust/nix/blob/master/CHANGELOG.md
68+
[kacl]: https://github.com/olivierlacan/keep-a-changelog/tree/18adb5f5be7a898d046f6a4acb93e39dcf40c4ad
69+
[pr-docs]: https://help.github.com/articles/using-pull-requests/
6570

6671
## Testing
6772

CONVENTIONS.md

+5
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ conventions we try to follow have been documented here. If you find an instance
99
of either, feel free to remedy the flaw by opening a pull request with
1010
appropriate changes or additions.
1111

12+
## Change Log
13+
14+
We follow the conventions laid out in [Keep A CHANGELOG][kacl].
15+
16+
[kacl]: https://github.com/olivierlacan/keep-a-changelog/tree/18adb5f5be7a898d046f6a4acb93e39dcf40c4ad
1217

1318
## libc constants, functions and structs
1419

RELEASE_PROCEDURE.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
This document lists the steps that lead to a successful release of the Nix
2+
library.
3+
4+
# Before Release
5+
6+
The release is prepared by a commit with the following changes.
7+
8+
- In CHANGELOG.md, rename the Unreleased section to the new version followed by
9+
the date of the release.
10+
11+
# Create Release
12+
13+
# After Release
14+
15+
After the release a commit with the following changes is added to the master
16+
branch.
17+
18+
- Add a new Unreleased section header to CHANGELOG.md.

0 commit comments

Comments
 (0)