summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs/include-documentation.rst
AgeCommit message (Collapse)AuthorFilesLines
2017-08-28Add docs on how to remove a submoduleagardner1-0/+11
Change-Id: Ic2ff79ef9d9937466183bfeacc9fec92116dca02 Signed-off-by: agardner <agardner@linuxfoundation.org>
2017-07-13Correction, documentation guideSofia Wallin1-1/+1
Change-Id: If6ea180c77e24ed07eb66ffdc92067e25c8144b3 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2017-05-08Add infra submoduleagardner1-0/+15
document how to add submodules clean up some spacing Change-Id: I7640f123911650dcf31933ed2fbfbdd26620798a Signed-off-by: agardner <agardner@linuxfoundation.org>
2017-03-08Fixed warningsSofia Wallin1-10/+10
Updated structure for test docs Updates done according to agreement with test projects. Change-Id: I2f9b5783ef4e42fd26b357e0aad2e187bcf61777 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2017-02-21Update OPNFVDocs documentationShubhamRathi1-2/+20
1. Added note about eliminating conf.py etc from include-documentation. 2. Eliminated content about enabling toolchain since its irrelevant after migration to RTD 3. Added steps to validate using doc8 4. Populated index page. Change-Id: I80c8354fd4da4bca0b8f338c178f0773d834b6ee Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-13Merge "Added steps to build documentation"Sofia Wallin1-0/+83
2017-02-11Added steps to build documentationShubhamRathi1-0/+83
Added steps to build composite & discreet documentation in include-documentation. Added development in progress label atop index. Change-Id: I28526f157a09e10faf17307445c4d90a3903be03 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-08Documentation guide ported from wikiShubhamRathi1-1/+1
Edited content to enforce the new changes. Added label to include-documentation.rst file which is referenced from the documentation guide. Change-Id: I6e81288062716231ece5934a0be934ed0dbb60dc Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-31New docs for 'How to include documentation'ShubhamRathi1-37/+98
This documentation elucidates the revised procedure to include project documentation. Change-Id: Icfcab3a07e386453ae7faf9fa737fe726ff70f0c Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-24Original 'Including your Documentation'ShubhamRathi1-0/+66
Moving all content out of the wiki, plan is to keep document build instructions in the opnfvdocs repo too. This file shall be edited with the new instruction. Change-Id: Ie2e441be1810182c101bd3819ddc6587e1c6b2c2 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
span class="k">const char *saddr); int parse_range(uint32_t* lo, uint32_t* hi, const char *saddr); /* parses CIDR notation. Note that bits within the address that are outside the subnet (as specified by the prefix) are set to 0. */ int parse_ip4_cidr(struct ip4_subnet *val, const char *saddr); int parse_ip6_cidr(struct ip6_subnet *val, const char *saddr); int parse_ip(uint32_t *paddr, const char *saddr); int parse_ip6(struct ipv6_addr *addr, const char *saddr); int parse_mac(struct ether_addr *paddr, const char *saddr); /* return error on overflow or invalid suffix*/ int parse_kmg(uint32_t* val, const char *str); int parse_bool(uint32_t* val, const char *str); int parse_flag(uint32_t* val, uint32_t flag, const char *str); int parse_list_set(uint32_t *list, const char *str, uint32_t max_limit); int parse_task_set(struct core_task_set *val, const char *str); int parse_int(uint32_t* val, const char *str); int parse_float(float* val, const char *str); int parse_u64(uint64_t* val, const char *str); int parse_str(char* dst, const char *str, size_t max_len); int parse_path(char *dst, const char *str, size_t max_len); int parse_port_name(uint32_t *val, const char *str); /* The syntax for random fields is X0010101XXX... where X is a randomized bit and 0, 1 are fixed bit. The resulting mask and fixed arguments are in BE order. */ int parse_random_str(uint32_t *mask, uint32_t *fixed, uint32_t *len, const char *str); int parse_port_name_list(uint32_t *val, uint32_t *tot, uint8_t max_vals, const char *str); /* Parses a comma separated list containing a remapping of ports specified by their name. Hence, all port names referenced from the list have to be added using add_port_name() before this function can be used. The first elements in the list are mapped to 0, the second to 1, etc. Multiple elements can be mapped to the same index. If multiple elements are used, they are separated by pipes. An example would be p0|p1,p2|p3. In this example, p0 and p1 both map to 0 and p2 and p3 map both map to 1. The mapping should contain at least enough entries as port ids. */ int parse_remap(uint8_t *mapping, const char *str); /* Convert an lcore_id to socket notation */ int lcore_to_socket_core_ht(uint32_t lcore_id, char *dst, size_t len); int add_port_name(uint32_t val, const char *str); /* The $self variable is something that can change its value (i.e. its value represents the core that is currently being parsed). */ int set_self_var(const char *str); int add_var(const char* name, const char *val, uint8_t cli); /* Parses str and returns pointer to the key value */ char *get_cfg_key(char *str); /* Changes strings in place. */ void strip_spaces(char *strings[], const uint32_t count); /* Contains error string if any of the above returned an error. */ const char* get_parse_err(void); /* Returns true if running from a virtual machine. */ int is_virtualized(void); int parse_single_var(char *val, size_t len, const char *name); #endif /* _PARSE_UTILS_H_ */