upstream/kallithea Files · docs/usage/debugging.rst

docs: rework stuff...

docs: rework stuff The existing docs were far from how we wanted it to be. There was so much to do and it is not feasible to do that cleanup it in clean patches. Instead, I took a sweep through the docs and changed what I thought could benefit from a change: structure, examples, advices, language, markup, content, etc.

Mads Kiilerich - - Load All Authors

File last commit:

r4902:03bbd33b default


                r4902:03bbd33b

default

Download file

             debugging.rst
        
                    30 lines
            
             | 1.1 KiB
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / usage / debugging.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        marcink
    
docs about debugging

              r2119
            
      .. _debugging:

      ===================

        Bradley M. Kuhn
    
Rename some strings examples and commands in documentation

              r4192
            
      Debugging Kallithea

        marcink
    
docs about debugging

              r2119
            
      ===================

        Bradley M. Kuhn
    
Rename some strings examples and commands in documentation

              r4192
            
      If you encountered problems with Kallithea here are some instructions how to

        marcink
    
docs about debugging

              r2119
            
      possibly debug them.

      ** First make sure you're using the latest version available.**

        Mads Kiilerich
    
docs: rework stuff...

              r4902
            
      Enable detailed debug

        marcink
    
docs about debugging

              r2119
            
      ---------------------

        Bradley M. Kuhn
    
Rename some strings examples and commands in documentation

              r4192
            
      Kallithea uses standard python logging modules to log it's output.

        marcink
    
docs about debugging

              r2119
            
      By default only loggers with INFO level are displayed. To enable full output

        marcink
    
whitespace cleanup

              r3224
            
      change `level = DEBUG` for all logging handlers in currently used .ini file.

        marcink
    
more detailed logging on auth system...

              r2125
            
      This change will allow to see much more detailed output in the logfile or

      console. This generally helps a lot to track issues.

        marcink
    
docs about debugging

              r2119
            
        Mads Kiilerich
    
docs: rework stuff...

              r4902
            
      Enable interactive debug mode

        marcink
    
docs about debugging

              r2119
            
      -----------------------------

        marcink
    
more detailed logging on auth system...

              r2125
            
      To enable interactive debug mode simply comment out `set debug = false` in

      .ini file, this will trigger and interactive debugger each time there an

      error in browser, or send a http link if error occured in the backend. This

      is a great tool for fast debugging as you get a handy python console right

      in the web view. ** NEVER ENABLE THIS ON PRODUCTION ** the interactive console

      can be a serious security threat to you system.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

marcink docs about debugging	r2119	.. _debugging:

		===================
Bradley M. Kuhn Rename some strings examples and commands in documentation	r4192	Debugging Kallithea
marcink docs about debugging	r2119	===================

Bradley M. Kuhn Rename some strings examples and commands in documentation	r4192	If you encountered problems with Kallithea here are some instructions how to
marcink docs about debugging	r2119	possibly debug them.

		First make sure you're using the latest version available.

Mads Kiilerich docs: rework stuff...	r4902	Enable detailed debug
marcink docs about debugging	r2119	---------------------

Bradley M. Kuhn Rename some strings examples and commands in documentation	r4192	Kallithea uses standard python logging modules to log it's output.
marcink docs about debugging	r2119	By default only loggers with INFO level are displayed. To enable full output
marcink whitespace cleanup	r3224	change `level = DEBUG` for all logging handlers in currently used .ini file.
marcink more detailed logging on auth system...	r2125	This change will allow to see much more detailed output in the logfile or
		console. This generally helps a lot to track issues.
marcink docs about debugging	r2119

Mads Kiilerich docs: rework stuff...	r4902	Enable interactive debug mode
marcink docs about debugging	r2119	-----------------------------

marcink more detailed logging on auth system...	r2125	To enable interactive debug mode simply comment out `set debug = false` in
		.ini file, this will trigger and interactive debugger each time there an
		error in browser, or send a http link if error occured in the backend. This
		is a great tool for fast debugging as you get a handy python console right
		in the web view. NEVER ENABLE THIS ON PRODUCTION the interactive console
		can be a serious security threat to you system.