Преглед на файлове

Fix a few documentation issues. NFC.

whitequark преди 7 години
родител
ревизия
46365af7bc
променени са 2 файла, в които са добавени 3 реда и са изтрити 2 реда
  1. 2 2
      README.md
  2. 1 0
      src/socket/tcp.rs

+ 2 - 2
README.md

@@ -216,13 +216,13 @@ The host is assigned the hardware address `02-00-00-00-00-02` and IPv4 address `
 Read its [source code](/examples/httpclient.rs), then run it as:
 
 ```sh
-cargo run --example client -- tap0 ADDRESS URL
+cargo run --example httpclient -- tap0 ADDRESS URL
 ```
 
 For example:
 
 ```sh
-cargo run --example client -- tap0 93.184.216.34 http://example.org/
+cargo run --example httpclient -- tap0 93.184.216.34 http://example.org/
 ```
 
 It connects to the given address (not a hostname) and URL, and prints any returned response data.

+ 1 - 0
src/socket/tcp.rs

@@ -10,6 +10,7 @@ use wire::{IpProtocol, IpRepr, IpAddress, IpEndpoint, TcpSeqNumber, TcpRepr, Tcp
 use socket::{Socket, SocketMeta, SocketHandle};
 use storage::{Assembler, RingBuffer};
 
+/// A TCP socket ring buffer.
 pub type SocketBuffer<'a> = RingBuffer<'a, u8>;
 
 /// The state of a TCP socket, according to [RFC 793][rfc793].