Skip to content

Commit

Permalink
Merge log-docindex-7904: Update links to logger's documentation.
Browse files Browse the repository at this point in the history
Author: glyph
Reviewer: wsanchez
Fixes: twisted#7904

git-svn-id: svn://svn.twistedmatrix.com/svn/Twisted/trunk@44880 bbbe8e31-12d6-0310-92fd-ac37d47ddeeb
  • Loading branch information
hawkowl committed May 20, 2015
1 parent c0b7f71 commit c12f083
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 13 deletions.
8 changes: 5 additions & 3 deletions docs/core/howto/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,12 +193,15 @@ Developer Guides

Utilities

- :doc:`Logging <logging>`
- :doc:`Emitting and Observing Logs <logger>`

Keep a record of what your application is up to, and inspect that record to discover interesting information.
(You may also be interested in the :doc:`legacy logging system <logging>` if you are maintaining code written to work with older versions of Twisted.)

Keep a record of what your application is up to.
- :doc:`Symbolic constants <constants>`

enum-like constants.

- :doc:`Twisted RDBMS support with adbapi <rdbms>`

Using SQL with your relational database via DB-API adapters.
Expand All @@ -215,7 +218,6 @@ Developer Guides

Using wrappers for sendmsg(2) and recvmsg(2).


- .. _core-howto-index-amp:

Asynchronous Messaging Protocol (AMP)
Expand Down
16 changes: 6 additions & 10 deletions docs/core/howto/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,17 @@
:LastChangedRevision: $LastChangedRevision$
:LastChangedBy: $LastChangedBy$

Logging with twisted.python.log
===============================
Twisted's Legacy Logging System: ``twisted.python.log``
=======================================================


Note: New Logging System
------------------------
.. note::

There is now a new logging system in Twisted (:api:`twisted.logger <twisted.logger>`) which is a replacement for :api:`twisted.python.log <twisted.python.log>`.

The old logging API, described here, remains for compatibility, and is now implemented as a client of the new logging system.

New code should adopt the new API.
The new API, and notes on transitioning from the old API, is documented in the :ref:`logger HOWTO <core-howto-logger-main>`.
There is now a new logging system in Twisted (:doc:`you can read about how to use it here <logger>` and :api:`twisted.logger <its API reference here>`) which is a replacement for :api:`twisted.python.log <twisted.python.log>`.

The old logging API, described here, remains for compatibility, and is now implemented as a client of the new logging system.

New code should adopt the new API.

Basic usage
-----------
Expand Down
1 change: 1 addition & 0 deletions twisted/topfiles/7904.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
twisted.logger's documentation is now correctly listed in the table of contents.

0 comments on commit c12f083

Please sign in to comment.