mirror of
https://gitee.com/openharmony/third_party_rust_nix
synced 2025-02-09 01:26:57 +00:00
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.
This commit is contained in:
Philipp Matthias Schaefer
parent
9e34676be7
commit
363fc28b48
90
CHANGELOG.md
Normal file
90
CHANGELOG.md
Normal file
@ -0,0 +1,90 @@
|
||||
# Change Log
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
This project adheres to [Semantic Versioning](http://semver.org/).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Added
|
||||
- Added `lseek` and `lseek64` in `::nix::unistd`
|
||||
([#377](https://github.com/nix-rust/nix/pull/377))
|
||||
- Added accessors `sigmask_mut` and `sigmask` to `UContext` in
|
||||
`::nix::ucontext`.
|
||||
([#370](https://github.com/nix-rust/nix/pull/370))
|
||||
- Added `WUNTRACED` to `WaitPidFlag` in `::nix::sys::wait` for non-_linux_
|
||||
targets.
|
||||
([#379](https://github.com/nix-rust/nix/pull/379))
|
||||
- Added new module `::nix::sys::reboot` with enumeration `RebootMode` and
|
||||
functions `reboot` and `set_cad_enabled`. Currently for _linux_ only.
|
||||
([#386](https://github.com/nix-rust/nix/pull/386))
|
||||
|
||||
### Changed
|
||||
- Replaced the reexported integer constants for signals by the enumeration
|
||||
`Signal` in `::nix::sys::signal`.
|
||||
([#362](https://github.com/nix-rust/nix/pull/362))
|
||||
- Renamed `EventFdFlag` to `EfdFlags` in `::nix::sys::eventfd`.
|
||||
([#383](https://github.com/nix-rust/nix/pull/383))
|
||||
|
||||
### Removed
|
||||
- Type alias `SigNum` from `::nix::sys::signal`.
|
||||
([#362](https://github.com/nix-rust/nix/pull/362))
|
||||
|
||||
### Fixed
|
||||
- Fixed the build problem for NetBSD (Note, that we currently do not support
|
||||
it, so it might already be broken again).
|
||||
([#389](https://github.com/nix-rust/nix/pull/389))
|
||||
|
||||
## [0.6.0] 2016-06-10
|
||||
|
||||
### Added
|
||||
- Added `gettid` in `::nix::unistd` for _linux_ and _android_.
|
||||
([#293](https://github.com/nix-rust/nix/pull/293))
|
||||
- Some _mips_ support in `::nix::sched` and `::nix::sys::syscall`.
|
||||
([#301](https://github.com/nix-rust/nix/pull/301))
|
||||
- Added `SIGNALFD_SIGINFO_SIZE` in `::nix::sys::signalfd`.
|
||||
([#309](https://github.com/nix-rust/nix/pull/309))
|
||||
- Added new module `::nix::ucontext` with struct `UContext`. Currently for
|
||||
_linux_ only.
|
||||
([#311](https://github.com/nix-rust/nix/pull/311))
|
||||
- Added `EPOLLEXCLUSIVE` to `EpollEventKind` in `::nix::sys::epoll`.
|
||||
([#330](https://github.com/nix-rust/nix/pull/330))
|
||||
- Added `pause` to `::nix::unistd`.
|
||||
([#336](https://github.com/nix-rust/nix/pull/336))
|
||||
- Added `sleep` to `::nix::unistd`.
|
||||
([#351](https://github.com/nix-rust/nix/pull/351))
|
||||
- Added `S_IFDIR`, `S_IFLNK`, `S_IFMT` to `SFlag` in `::nix::sys::stat`.
|
||||
([#359](https://github.com/nix-rust/nix/pull/359))
|
||||
- Added `clear` and `extend` functions to `SigSet`'s implementation in
|
||||
`::nix::sys::signal`.
|
||||
([#347](https://github.com/nix-rust/nix/pull/347))
|
||||
- `sockaddr_storage_to_addr` in `::nix::sys::socket` now supports `sockaddr_nl`
|
||||
on _linux_ and _android_.
|
||||
([#366](https://github.com/nix-rust/nix/pull/366))
|
||||
- Added support for `SO_ORIGINAL_DST` in `::nix::sys::socket` on _linux_.
|
||||
([#367](https://github.com/nix-rust/nix/pull/367))
|
||||
- Added `SIGINFO` in `::nix::sys::signal` for the _macos_ target as well as
|
||||
`SIGPWR` and `SIGSTKFLT` in `::nix::sys::signal` for non-_macos_ targets.
|
||||
([#361](https://github.com/nix-rust/nix/pull/361))
|
||||
|
||||
### Changed
|
||||
- Changed the structure `IoVec` in `::nix::sys::uio`.
|
||||
([#304](https://github.com/nix-rust/nix/pull/304))
|
||||
- Replaced `CREATE_NEW_FD` by `SIGNALFD_NEW` in `::nix::sys::signalfd`.
|
||||
([#309](https://github.com/nix-rust/nix/pull/309))
|
||||
- Renamed `SaFlag` to `SaFlags` and `SigFlag` to `SigFlags` in
|
||||
`::nix::sys::signal`.
|
||||
([#314](https://github.com/nix-rust/nix/pull/314))
|
||||
- Renamed `Fork` to `ForkResult` and changed its fields in `::nix::unistd`.
|
||||
([#332](https://github.com/nix-rust/nix/pull/332))
|
||||
- Added the `signal` parameter to `clone`'s signature in `::nix::sched`.
|
||||
([#344](https://github.com/nix-rust/nix/pull/344))
|
||||
- `execv`, `execve`, and `execvp` now return `Result<Void>` instead of
|
||||
`Result<()>` in `::nix::unistd`.
|
||||
([#357](https://github.com/nix-rust/nix/pull/357))
|
||||
|
||||
### Fixed
|
||||
- Improved the conversion from `std::net::SocketAddr` to `InetAddr` in
|
||||
`::nix::sys::socket::addr`.
|
||||
([#335](https://github.com/nix-rust/nix/pull/335))
|
||||
|
||||
## [0.5.0] 2016-03-01
|
||||
@ -60,8 +60,13 @@ pull' model described there.
|
||||
|
||||
Please make pull requests against the `master` branch.
|
||||
|
||||
[pr-docs]: https://help.github.com/articles/using-pull-requests/
|
||||
If you change the API by way of adding, removing or changing something or if
|
||||
you fix a bug, please add an appropriate note to the [change log][cl]. We
|
||||
follow the conventions of [Keep A CHANGELOG][kacl].
|
||||
|
||||
[cl]: https://github.com/nix-rust/nix/blob/master/CHANGELOG.md
|
||||
[kacl]: https://github.com/olivierlacan/keep-a-changelog/tree/18adb5f5be7a898d046f6a4acb93e39dcf40c4ad
|
||||
[pr-docs]: https://help.github.com/articles/using-pull-requests/
|
||||
|
||||
## Testing
|
||||
|
||||
|
||||
@ -9,6 +9,11 @@ conventions we try to follow have been documented here. If you find an instance
|
||||
of either, feel free to remedy the flaw by opening a pull request with
|
||||
appropriate changes or additions.
|
||||
|
||||
## Change Log
|
||||
|
||||
We follow the conventions laid out in [Keep A CHANGELOG][kacl].
|
||||
|
||||
[kacl]: https://github.com/olivierlacan/keep-a-changelog/tree/18adb5f5be7a898d046f6a4acb93e39dcf40c4ad
|
||||
|
||||
## libc constants, functions and structs
|
||||
|
||||
|
||||
18
RELEASE_PROCEDURE.md
Normal file
18
RELEASE_PROCEDURE.md
Normal file
@ -0,0 +1,18 @@
|
||||
This document lists the steps that lead to a successful release of the Nix
|
||||
library.
|
||||
|
||||
# Before Release
|
||||
|
||||
The release is prepared by a commit with the following changes.
|
||||
|
||||
- In CHANGELOG.md, rename the Unreleased section to the new version followed by
|
||||
the date of the release.
|
||||
|
||||
# Create Release
|
||||
|
||||
# After Release
|
||||
|
||||
After the release a commit with the following changes is added to the master
|
||||
branch.
|
||||
|
||||
- Add a new Unreleased section header to CHANGELOG.md.
|
||||
Loading…
x
Reference in New Issue
Block a user