Skip to content

Commit

Permalink
Docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
fredrikwidlund committed Jan 3, 2017
1 parent 705a26e commit cff1b9b
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ the ``--prefix=DIR`` argument to ``./configure``. See ``./configure
--help`` for the list of all possible configuration options.

The command ``make check`` runs the test suite distributed with
libreactor. This step is not strictly necessary, but it may find possible
problems that libreactor has on your platform. If any problems are found,
libdynamic. This step is not strictly necessary, but it may find possible
problems that libdynamic has on your platform. If any problems are found,
please report them.

If you obtained the source from a Git repository (or any other source
Expand Down
2 changes: 1 addition & 1 deletion docs/changes.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
*********************
Changes in libreactor
Changes in libdynamic
*********************

.. include:: ../CHANGES
8 changes: 4 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# libreactor documentation build configuration file, built using the Jansson
# libdynamic documentation build configuration file, built using the Jansson
# project as a template
#
# This file is execfile()d with the current directory set to its containing dir.
Expand Down Expand Up @@ -164,7 +164,7 @@
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'libreactordoc'
htmlhelp_basename = 'libdynamicdoc'


# -- Options for LaTeX output --------------------------------------------------
Expand All @@ -178,7 +178,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'libreactor.tex', u'libreactor Documentation',
('index', 'libdynamic.tex', u'libdynamic Documentation',
u'Fredrik Widlund', 'manual'),
]

Expand Down Expand Up @@ -211,6 +211,6 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'libreactor', u'libreactor Documentation',
('index', 'libdynamic', u'libdynamic Documentation',
[u'Fredrik Widlund'], 1)
]
6 changes: 3 additions & 3 deletions docs/gettingstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ the ``--prefix=DIR`` argument to ``./configure``. See ``./configure
--help`` for the list of all possible configuration options.

The command ``make check`` runs the test suite distributed with
libreactor. This step is not strictly necessary, but it may find possible
problems that libreactor has on your platform. If any problems are found,
libdynamic. This step is not strictly necessary, but it may find possible
problems that libdynamic has on your platform. If any problems are found,
please report them.

If you obtained the source from a Git repository (or any other source
Expand Down Expand Up @@ -81,7 +81,7 @@ or newer is required to generate the documentation.
Compiling programs that use libdynamic
======================================

libreactor headers files are included through one C header file, :file:`dynamic.h`, so it's enough
libdynamic headers files are included through one C header file, :file:`dynamic.h`, so it's enough
to put the line

::
Expand Down
10 changes: 5 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
libreactor Documentation
libdynamic Documentation
========================

This is the documentation for libreactor_ |release|, last updated |today|.
This is the documentation for libdynamic_ |release|, last updated |today|.

Introduction
------------

libreactor_ is a C library for various dynamic container types. Its main features and design principles are:
libdynamic_ is a C library for various dynamic container types. Its main features and design principles are:

- High performance/low overhead

Expand All @@ -18,10 +18,10 @@ libreactor_ is a C library for various dynamic container types. Its main feature

Where appropriate, containers are modelled roughly after the stdc++ equivalents.

libreactor is licensed under the `MIT license`_; see LICENSE in the
libdynamic_ is licensed under the `MIT license`_; see LICENSE in the
source distribution for details.

.. _libreactor: https://github.com/fredrikwidlund/libdynamic
.. _libdynamic: https://github.com/fredrikwidlund/libdynamic
.. _`MIT license`: http://www.opensource.org/licenses/mit-license.php

Contents
Expand Down
2 changes: 1 addition & 1 deletion libdynamic.pc.in
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ exec_prefix=@exec_prefix@
libdir=@libdir@
includedir=${prefix}/include

Name: libreactor
Name: libdynamic
Description: C library for various dynamic container types
Version: @VERSION@
Libs: -L${libdir} -ldynamic
Expand Down

0 comments on commit cff1b9b

Please sign in to comment.