diff options
author | bluemonk <ceresa@gmail.com> | 2010-07-18 14:55:04 +0200 |
---|---|---|
committer | bluemonk <ceresa@gmail.com> | 2010-07-18 14:55:04 +0200 |
commit | bea4380c30668c9ea0649c5eb2ef2c0ad61096ee (patch) | |
tree | 5f3eb5858fd19f5fb6c757d1de1da27c79f4f2b4 | |
parent | 2169d58e12815c9dec0b1ced515fa4b0e36ef10a (diff) | |
download | ipaddress-bea4380c30668c9ea0649c5eb2ef2c0ad61096ee.tar.gz |
Fixed some documentation and formatted CHANGELOG with rdoc
-rw-r--r-- | CHANGELOG.rdoc (renamed from CHANGELOG) | 14 | ||||
-rw-r--r-- | README.rdoc | 17 |
2 files changed, 16 insertions, 15 deletions
diff --git a/CHANGELOG b/CHANGELOG.rdoc index a2eeecf..65d800a 100644 --- a/CHANGELOG +++ b/CHANGELOG.rdoc @@ -1,8 +1,7 @@ -ipaddress 0.6.0 ---------------- +== ipaddress 0.6.0 -API changes +=== API changes * IPv4#to_s now returns the address portion only, to retain compatibility with IPAddr. Example: @@ -24,12 +23,11 @@ API changes * IPv6::Unspecified#to_s, IPv6::Loopback and IPv6::Mapped#to_s now return the address portion only, to retain compatibility with IPAddr. - * IPv4::summarize now returns an array even if the result is a single subnet, to keep consistency and avoid confusion -New methods +=== New methods * IPv4#to_string and IPv6#to_string: print the address with the prefix portion, like the #to_s method in ipaddress 0.5.0 @@ -45,7 +43,7 @@ New methods methods * Prefix#+, Prefix#- -Library structure +=== Library structure * Moved all the IPAddress module methods from lib/ipaddress/ipbase.rb to lib/ipaddress.rb * Removed IPBase superclass @@ -53,7 +51,7 @@ Library structure * Removed lib/ipaddress/ipbase.rb * Removed test/ipaddress/ipbase_test.rb -Minor fixes +=== Minor fixes * Replaced Ruby 1.9 deprecated Hash#index with Hash#key * Removed require ruby-prof from tests which was causing users to install ruby-prof or manually remove the line @@ -65,7 +63,7 @@ Minor fixes * Fixed summarization algorithm (thanks to nicolas fevrier) * Fixed bug in prefix_from_ip (thanks to jdpace) -Documentation +=== Documentation * Normalized README rdoc headers * Added documentation for IPAddress::Prefix * Added documentation for IPAddress::IPv4 and diff --git a/README.rdoc b/README.rdoc index 99f6647..cd804d6 100644 --- a/README.rdoc +++ b/README.rdoc @@ -34,6 +34,9 @@ Some quick examples of things you can't do with IPAddr: * iterate over hosts * perform subnetting or network aggregation +Moreover, many methods and procedures are so old that they have been +declared deprecated by the IETF. + We hope that IPAddress will address all these issues and meet all your needs in network programming. @@ -257,7 +260,7 @@ address: #=> #<IPAddress::IPv4:0xb7a406fc @octets=[172, 16, 10, 255], @prefix=24, @address="172.16.10.255"> - bcast.to_s + bcast.to_string #=> "172.16.10.255/24" ===== Addresses, ranges and iterators @@ -442,7 +445,7 @@ instance the following two networks: These two networks can be expressed using only one IP address network if we change the prefix. Let Ruby do the work: - IPAddress::IPv4::summarize(ip1,ip2).to_s + IPAddress::IPv4::summarize(ip1,ip2).to_string #=> "172.16.10.0/23" We note how the network "172.16.10.0/23" includes all the @@ -500,13 +503,13 @@ example, given the network you can supernet it with a new /23 prefix - ip.supernet(23).to_s + ip.supernet(23).to_string #=> "172.16.10.0/23" However if you supernet it with a /22 prefix, the network address will change: - ip.supernet(22).to_s + ip.supernet(22).to_string #=> "172.16.8.0/22" This is because "172.16.10.0/22" is not a network anymore, but an host @@ -638,8 +641,8 @@ or to hexadecimal representation ip6.to_hex #=> "20010db80000000000080800200c417a" -To print out an IPv6 address in human readable form, use the IPv6#to_s -and IPv6#to_string methods +To print out an IPv6 address in human readable form, use the IPv6#to_s, IPv6#to_string +and IPv6#to_string_uncompressed methods ip6 = IPAddress "2001:db8::8:800:200c:417a/64" @@ -744,7 +747,7 @@ subclass: ip = IPAddress::IPv6::Unspecified.new ip.to_string - #=> => "::/128" + #=> "::/128" You can easily check if an IPv6 object is an unspecified address by using the IPv6#unspecified? method |