Skip to content

Commit

Permalink
New changelog format
Browse files Browse the repository at this point in the history
  • Loading branch information
schweikert committed Apr 23, 2017
1 parent 06dfaef commit ef0ab38
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 129 deletions.
80 changes: 80 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
fping 4.0 (2017-04-23)
======================

## Incompatible Changes

##### fping and fping6 unification

fping and fping6 are now unified into one binary. It means that, for example,
doing 'fping google.com' is going to ping the IPv6 IP of google.com on
IPv6-enabled hosts.

If you need exact compatibility with old versions, you can configure and
install fping twice: once for ipv4, and once for ipv6:

./configure --disable-ipv6; make clean install
./configure --disable-ipv4 --program-suffix=6; make clean install

##### Option -n, not the same as -d anymore

Option -n / --name is now doing a reverse-DNS lookups on host addresses,
only if they are given as IP address, but not for hostnames. For example,
if you write 'fping -n google.com', fping would previously do a
forward-DNS lookup on google.com, and then a reverse-DNS lookup on the
resolved IP address. Now, it is just going to keep the name 'google.com'.
That same behavior can be achieved with the option -d / --rdns (which was
previously an alias for -n).

fping<4.0 fping>=4.0
fping -n NAME NAME->IP->IPNAME NAME
fping -d NAME NAME->IP->IPNAME NAME->IP->IPNAME

##### Discarding of late packets

fping will now discard replies, if they arrive after the defined timeout
for reply packets, specified with -t. This change is relevant only for the
count and loop modes, where the measured times should be now more
consistent (see github issue #32 for details).

To prevent loosing reply packets because of this change, the default
timeout in count and loop modes is now automatically adjusted to the
period interval (up to 2000 ms), but it can be overriden with the -t
option. The default timeout for non-loop/count modes remains 500 ms.

##### No restrictions by default

fping will not enforce -i >= 1 and -p >= 10 anymore, except if you
'./configure --enable-safe-limits'.

The reasoning to removing the restrictions by default, is that users can
clog the network with other tools anyway, and these restrictions are
sometimes getting in the way (for example if you try to ping a lot of
hosts).

##### Default interval (-i) changed from 25ms to 10ms

The default minimum interval between ping probes has been changed from
25ms to 10ms. The reason is that 25ms is very high, considering today's
fast networks: it generates at most 31 kbps of traffic (for IPv4 and
default payload size).

## New features

- Unified 'fping' and 'fping6' into one binary (#80)
- Long option names for all options
- IPv6 enabled by default
- New option -4 to force IPv4
- New option -6 to force IPv6
- Keep original name if a hostname is given with -n/--name
- Option -d/--rdns now always does a rdns-lookup, even for names, as '-n' was doing until now
- Enforce -t timeout on reply packets, by discarding late packets (#32)
- Auto-adjust timeout for -c/-C/-l mode to value of -p

## Bugfixes and other changes

- -i/-p restrictions disabled by default (enable with --enable-safe-limits)
- Default interval -i changed from 25ms to 10ms
- Fix compatibility issue with GNU Hurd
- A C99 compiler is now required
- Option parsing with optparse (https://github.com/skeeto/optparse). Thanks Christopher Wellons!
- New changelog file format
55 changes: 0 additions & 55 deletions README

This file was deleted.

74 changes: 0 additions & 74 deletions ChangeLog → doc/CHANGELOG.pre-v4
Original file line number Diff line number Diff line change
@@ -1,77 +1,3 @@
2017-02-13 David Schweikert <[email protected]>
* Version 4.0-rc3

* INCOMPATIBILE CHANGE: fping and fping6 unification

fping and fping6 are now unified into one binary. It means that, for
example, doing 'fping google.com' is going to ping the IPv6 IP of
google.com on IPv6-enabled hosts.

If you need exact compatibility with old versions, you can configure and
install fping twice: once for ipv4, and once for ipv6:
- ./configure --disable-ipv6; make clean install
- ./configure --disable-ipv4 --program-suffix=6; make clean install

* INCOMPATIBILE CHANGE: -n option, not the same as -d anymore

Option -n / --name is now doing a reverse-DNS lookups on host addresses,
only they are given as IP address, but not for hostnames. For example, if
you write 'fping -n google.com', fping would previously do a forward-DNS
lookup on google.com, and then a reverse-DNS lookup on the resolved IP
address. Now, it is just going to keep the name 'google.com'. That same
behavior can be achieved with the option -d / --rdns (which was previously
an alias for -n).

fping<4.0 fping>=4.0
fping -n NAME NAME->IP->IPNAME NAME
fping -d NAME NAME->IP->IPNAME NAME->IP->IPNAME

* INCOMPATIBILE CHANGE: discard late packets

fping will now discard replies, if they arrive after the defined timeout
for reply packets, specified with -t. This change is relevant only for the
count and loop modes, where the measured times should be now more
consistent (see github issue #32 for details).

To prevent loosing reply packets because of this change, the default
timeout in count and loop modes is now automatically adjusted to the
period interval (up to 2000 ms), but it can be overriden with the -t
option. The default timeout for non-loop/count modes remains 500 ms.

* INCOMPATIBLE CHANGE: no restrictions by default

fping will not enforce -i >= 1 and -p >= 10 anymore, except if you
'./configure --enable-safe-limits'.

The reasoning to removing the restrictions by default, is that users can
clog the network with other tools anyway, and these restrictions are
sometimes getting in the way (for example if you try to ping a lot of
hosts).

* INCOMPATIBLE CHANGE: default interval (-i) changed from 25ms to 10ms

The default minimum interval between ping probes has been changed from
25ms to 10ms. The reason is that 25ms is very high, considering today's
fast networks: it generates at most 31 kbps of traffic (for IPv4 and
default payload size).

* (feature) Unified 'fping' and 'fping6' into one binary (#80)
* (feature) Long option names for all options
* (feature) --enable-ipv6 is now default
* (feature) New option -4 to force IPv4
* (feature) New option -6 to force IPv6
* (feature) Keep original name if a hostname is given with -n/--name
* (feature) Option -d/--rdns now always does a rdns-lookup, even for names
(name->IP->name), as '-n' was doing until now
* (feature) Enforce -t timeout on reply packets, by discarding late packets (#32)
* (feature) Auto-adjust timeout for -c/-C/-l mode to value of -p
* (feature) -i/-p restrictions only enforced with ./configure --enable-safe-limits
* (feature) Default interval -i changed from 25ms to 10ms
* (bugfix) Fix compatibility issue with GNU Hurd
* (other) A C99 compiler is now required
* (other) Option parsing with optparse (https://github.com/skeeto/optparse)
Thanks Christopher Wellons!

2017-02-09 David Schweikert <[email protected]>
* Version 3.16
* (feature) Support kernel-timestamping of received packets (#46)
Expand Down

0 comments on commit ef0ab38

Please sign in to comment.