Browse Source

[trac4264] Fix some typos in the comments and docs

Shawn Routhier 9 years ago
parent
commit
5439a449f4

+ 5 - 5
doc/guide/classify.xml

@@ -189,11 +189,11 @@ sub-option with code "code" from the Relay Agent Information option
       </para>
       </para>
 
 
       <para>
       <para>
-        "relay[code].hex" attempts to extract value of the sub-option
+        "relay[code].hex" attempts to extract the value of the sub-option
-        "code" from the option inserted by the Relay Agent Information
+        "code" from the option inserted as the Relay Agent Information
-        (82) option. If the packet doesn't contain RAI option, or RAI
+        (82) option. If the packet doesn't contain a RAI option, or the RAI
-        doesn't contain searched sub-option, the expression returns
+        option doesn't contain the requested sub-option, the expression returns
-        empty string. The string is presented as a byte string of the
+        an empty string. The string is presented as a byte string of the
         option payload without the type code or length fields. This
         option payload without the type code or length fields. This
         expression is allowed in DHCPv4 only.
         expression is allowed in DHCPv4 only.
       </para>
       </para>

+ 5 - 5
src/lib/eval/eval.dox

@@ -1,4 +1,4 @@
-// Copyright (C) 2015 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2015-2016 Internet Systems Consortium, Inc. ("ISC")
 //
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -128,7 +128,7 @@ instantiated with the appropriate value and put onto the expression vector.
 
 
 @section dhcpEcalToken Supported tokens
 @section dhcpEcalToken Supported tokens
 
 
- There is a number of tokens implemented. Each token is derived from
+ There are a number of tokens implemented. Each token is derived from
  isc::eval::Token class and represents a certain expression primitive.
  isc::eval::Token class and represents a certain expression primitive.
  Currently supported tokens are:
  Currently supported tokens are:
 
 
@@ -137,10 +137,10 @@ instantiated with the appropriate value and put onto the expression vector.
    hex string, e.g. 0x666f6f which is actually "foo";
    hex string, e.g. 0x666f6f which is actually "foo";
  - isc::dhcp::TokenOption - represents an option in a packet, e.g.
  - isc::dhcp::TokenOption - represents an option in a packet, e.g.
                     option[123].text;
                     option[123].text;
- - isc::dhcp::TokenEqual - represents equal (==) operator;
+ - isc::dhcp::TokenEqual - represents the equal (==) operator;
- - isc::dhcp::TokenSubstring - represents substring(text, start, length) operator;
+ - isc::dhcp::TokenSubstring - represents the substring(text, start, length) operator;
  - isc::dhcp::TokenRelay4Option - represents a sub-option inserted by the
  - isc::dhcp::TokenRelay4Option - represents a sub-option inserted by the
-                    DHCPv4 relay, e.g. relay[123].text or relay[123].bin
+                    DHCPv4 relay, e.g. relay[123].text or relay[123].hex
 
 
 More operators are expected to be implemented in upcoming releases.
 More operators are expected to be implemented in upcoming releases.
 
 

+ 2 - 2
src/lib/eval/eval_context.h

@@ -1,4 +1,4 @@
-// Copyright (C) 2015 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2015-2016 Internet Systems Consortium, Inc. ("ISC")
 //
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -92,7 +92,7 @@ public:
     uint16_t convertOptionCode(const std::string& option_code,
     uint16_t convertOptionCode(const std::string& option_code,
                                const isc::eval::location& loc);
                                const isc::eval::location& loc);
 
 
-    /// @brief Option name convertion
+    /// @brief Option name conversion
     ///
     ///
     /// @param option_name the option name
     /// @param option_name the option name
     /// @param loc the location of the token
     /// @param loc the location of the token

+ 1 - 1
src/lib/eval/lexer.ll

@@ -1,4 +1,4 @@
-/* Copyright (C) 2015 Internet Systems Consortium, Inc. ("ISC")
+/* Copyright (C) 2015-2016 Internet Systems Consortium, Inc. ("ISC")
 
 
    This Source Code Form is subject to the terms of the Mozilla Public
    This Source Code Form is subject to the terms of the Mozilla Public
    License, v. 2.0. If a copy of the MPL was not distributed with this
    License, v. 2.0. If a copy of the MPL was not distributed with this

+ 1 - 1
src/lib/eval/parser.yy

@@ -1,4 +1,4 @@
-/* Copyright (C) 2015 Internet Systems Consortium, Inc. ("ISC")
+/* Copyright (C) 2015-2016 Internet Systems Consortium, Inc. ("ISC")
 
 
    This Source Code Form is subject to the terms of the Mozilla Public
    This Source Code Form is subject to the terms of the Mozilla Public
    License, v. 2.0. If a copy of the MPL was not distributed with this
    License, v. 2.0. If a copy of the MPL was not distributed with this

+ 1 - 1
src/lib/eval/tests/context_unittest.cc

@@ -1,4 +1,4 @@
-// Copyright (C) 2015 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2015-2016 Internet Systems Consortium, Inc. ("ISC")
 //
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // License, v. 2.0. If a copy of the MPL was not distributed with this

+ 2 - 2
src/lib/eval/tests/token_unittest.cc

@@ -1,4 +1,4 @@
-// Copyright (C) 2015 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2015-2016 Internet Systems Consortium, Inc. ("ISC")
 //
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -614,7 +614,7 @@ TEST_F(TokenTest, relayOption) {
 }
 }
 
 
 // This test checks that the code properly handles cases when
 // This test checks that the code properly handles cases when
-// there is RAI option, but there's no requested sub-option.
+// there is a RAI option, but there's no requested sub-option.
 TEST_F(TokenTest, relayOptionNoSuboption) {
 TEST_F(TokenTest, relayOptionNoSuboption) {
 
 
     // Insert relay option with sub-options 1 and 13
     // Insert relay option with sub-options 1 and 13

+ 1 - 1
src/lib/eval/token.cc

@@ -1,4 +1,4 @@
-// Copyright (C) 2015 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2015-2016 Internet Systems Consortium, Inc. ("ISC")
 //
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // License, v. 2.0. If a copy of the MPL was not distributed with this

+ 5 - 5
src/lib/eval/token.h

@@ -1,4 +1,4 @@
-// Copyright (C) 2015 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2015-2016 Internet Systems Consortium, Inc. ("ISC")
 //
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -283,8 +283,8 @@ public:
 /// @brief Represents a sub-option inserted by the DHCPv4 relay.
 /// @brief Represents a sub-option inserted by the DHCPv4 relay.
 ///
 ///
 /// DHCPv4 relays insert sub-options in option 82. This token attempts to extract
 /// DHCPv4 relays insert sub-options in option 82. This token attempts to extract
-/// such sub-options. Note it is radically different than in DHCPv6 (possible
+/// such sub-options. Note in DHCPv6 it is radically different (possibly
-/// many encapsulation levels), thus separate classes for v4 and v6.
+/// many encapsulation levels), thus there are separate classes for v4 and v6.
 ///
 ///
 /// This token can represent the following expressions:
 /// This token can represent the following expressions:
 /// relay[13].text - Textual representation of sub-option 13 in RAI (option 82)
 /// relay[13].text - Textual representation of sub-option 13 in RAI (option 82)
@@ -294,9 +294,9 @@ public:
 class TokenRelay4Option : public TokenOption {
 class TokenRelay4Option : public TokenOption {
 public:
 public:
 
 
-    /// @brief Construtor for extracting sub-option from RAI (option 82)
+    /// @brief Constructor for extracting sub-option from RAI (option 82)
     ///
     ///
-    /// @param option_code code of the searched sub-option
+    /// @param option_code code of the requested sub-option
     /// @param rep_type code representation (currently .hex and .text are supported)
     /// @param rep_type code representation (currently .hex and .text are supported)
     TokenRelay4Option(const uint16_t option_code,
     TokenRelay4Option(const uint16_t option_code,
                       const RepresentationType& rep_type);
                       const RepresentationType& rep_type);