Difference between pages "Package:Tmux" and "Reporting Bugs"

(Difference between pages)
 
m (update to include emerge --info && build log information per oleg's request.)
 
Line 1: Line 1:
{{Ebuild
+
The Funtoo community's goal is to provide a seamless and problem-free computing experience, and we take all bugs seriously. Please use the following resources for reporting bugs, technical support, and troubleshooting assistance:
|Summary=Terminal multiplexer
+
|CatPkg=app-misc/tmux
+
|Maintainer=
+
|Homepage=http://tmux.sourceforge.net/
+
}}
+
Tmux is a terminal multiplexer (just as [[Package:Screen (Terminal Multiplexer)|screen]], which is generally installed by default on servers). It enables you to run multiple terminals in one. You can arrange them in multiple tabs that you can split into multiple panes as well.
+
  
== Installation ==
+
=== Collecting Info ===
 +
Before submitting bugs collect information about your system, & problem.
  
<console>
+
{{console|body=###i## emerge --info > /tmp/emergeinfo.txt}}
###i## emerge -a tmux
+
</console>
+
  
== Getting Started ==
+
Towards the end of failed emerges are messages about build logs.
  
To launch Tmux, run <code>tmux</code> in a terminal. This should clear your current terminal and display a <i>status bar</i> on the bottom. In this status bar, you should see something like <i>"[0] 0:bash*"</i>. This means you are on session 0 (<b>[0]</b>), window 0 (<b>0:</b>) and you run "bash".
+
{{note|This is an example, your exact messages will vary. Use your emerge output rather than this example.}}
 +
* The complete build log is located at '/var/tmp/portage/sys-fs/lvm2-2.02.111/temp/build.log'
  
Tmux uses <b><code>Ctrl+b</code></b> as default prefix. This means that before issuing any command you will have to hit <b><code>Ctrl+b</code></b> to tell tmux you are asking <i>it</i>. For instance, type <b><code>Ctrl+b</code></b> and then <b><code>%</code></b>. This should split vertically the window to add a new pane. Now issue <b><code>Ctrl+b "</code></b>, this will split the new pane horizontally to create a new pane. You can switch against panes with <b><code>Ctrl+b Left/Up/Right/Down</code></b> (Left/Up/Right/Down being the arrow keys).
+
==== IRC ====
  
Another cool stuff is windows. Splitting your window into panes is good, but for readability purpose, you can't indefinitely split your window. So you can open a new window (which would behave more like a tab) by issuing <b><code>Ctrl+b c</code></b>. Your current window will be replaced by a brand new one. However you will notice that your status bar now looks like this <i>"[0] 0:bash- 1:bash*"</i>. The minus symbol (<b>-</b>) means this is the last visited window. The asterisk symbol (<b>*</b>) means this is the current window. You can add panes to this window as well. To go back to the first window, issue <b><code>Ctrl+b 0</code></b>. Generally speaking, issue <b><code>Ctrl+b <window-id></code></b> to go to the window <i><window-id></i>.
+
The {{c|#funtoo}} IRC channel on freenode available for informal, real-time technical support and troubleshooting. Please use Funtoo channels rather than Gentoo channels for Funtoo Linux support.
  
You can do much more with tmux, but this is the minimum to know if you want to quickly get started.
+
To share information on irc use {{package|app-text/wgetpaste}}, and share links rather than posting directly to the channel.
  
== Keyboard Shortcuts ==
+
==== Support Forums ====
  
{|class="table table-striped"
+
The following Web-based discussion resources are specifically created for community-based support and troubleshooting, and are monitored by the Funtoo Linux core team.  Under the new thread text area, attach the emerge info, and build logs directly to your posts rather than using wgetpaste links.  Wgetpaste links expire where the forums attached files are timeless.
!! Shortcut !! Description
+
|-
+
|| <code>C-b ?</code> || List all keybindings
+
|-
+
|| <code>C-b :</code> || Enter tmux command prompt
+
|-
+
|| <code>C-b d</code> || Detach session
+
|-
+
|| <code>C-b c</code> || Create window
+
|-
+
|| <code>C-b n</code> || Switch to next window
+
|-
+
|| <code>C-b p</code> || Switch to previous window
+
|-
+
|| <code>C-b l</code> || Switch to last window
+
|-
+
|| <code>C-b "</code> || Split current pane into top and bottom
+
|-
+
|| <code>C-b %</code> || Split current pane into left and right
+
|-
+
|| <code>C-b o</code> || Move to next pane
+
|-
+
|| <code>C-b ;</code> || Move to previous pane
+
|-
+
|| <code>C-b [</code> || Enter copy/scroll mode (type <code>q</code> to leave this mode)
+
|}
+
  
== Configuration ==
+
* [http://forums.funtoo.org/forum/7-installation-help/ Installation Help]
=== ~/.tmux.conf ===
+
* [http://forums.funtoo.org/forum/9-portage-help/ Portage Help]
Example tmux configuration shown below
+
* [http://forums.funtoo.org/forum/4-desktop-help/ Desktop Help]
<code>~/.tmux.conf</code> gets loaded on tmux startup.
+
* [http://forums.funtoo.org/forum/8-server-help/ Server Help]
{{file|name=~/.tmux.conf|lang=|desc=tmux configuration|body=
+
set -g base-index 1
+
set -g default-terminal "st-256color"
+
set -g history-limit 4096
+
set -g status-left ''
+
set -g status-right "#[bg=brightblack]#[fg=green] #T "
+
set -g status-style "bg=black"
+
  
setw -g pane-base-index 1
+
=== Bug tracker ===
setw -g window-status-format "#[bg=magenta]#[fg=black] #I #[bg=brightblack]#[fg=green] #W "
+
setw -g window-status-current-format "#[bg=brightmagenta]#[fg=black] #I #[bg=green]#[fg=black] #W "
+
  
bind r source-file ~/.tmux.conf
+
We are using JIRA for tracking Funtoo Linux issues. See [http://bugs.funtoo.org bugs.funtoo.org] to access the bug tracker.
}}
+
  
{{EbuildFooter}}
+
For information on how to properly use the bug tracker, see below.
 +
 
 +
==== How To Report Bugs ====
 +
 
 +
# First, {{CreateAccount}}.
 +
# Go to Issues -> Create Issue
 +
# Set Issue Type to "Bug".
 +
# For Summary, enter a clear description of the defect.
 +
# For Description, enter:
 +
## a clear, detailed description of the problem
 +
## clear steps to reproduce the problem
 +
## output of the failure
 +
## a description of what you expected to happen instead of the failure
 +
## attach emerge info, and build logs under bug description
 +
 
 +
When your issue is created, it will have a short name such as FL-17 that can be used to reference it.
 +
 
 +
Each issue is intended to track a specific defect in Funtoo Linux. Please respect the focus of each individual issue. Use the mailing lists and forums for general discussion.
 +
 
 +
==== Bug Status ====
 +
 
 +
When bugs are first reported, they are marked as ''Awaiting Review''. This means that they are waiting to be reviewed by staff. Once reviewed and possibly revised somewhat, they will be moved into ''Queued'' status. This means that the bug has been accepted and is in queue to being fixed. When a developer starts working on the bug, it will move to ''In Progress'' status. This means that the bug is being actively worked on. When the bug is resolved, it will move to ''Test/Integration'' status, which means that it will now be tested and fully integrated into Funtoo Linux. When it has been fully integrated into Funtoo Linux, it will be marked as ''Closed'', and the resolution will be set appropriately.
 +
 
 +
There are a few other statuses that are used. ''Upstream Review'' is used when a bug is submitted to an upstream project and is awaiting review or feedback. '''Workaround''' is used when a short-term fix is used to resolve a problem, but a longer-term fix is also required. There is also a ''Community Discussion'' status. This status is used when we are actively requesting community feedback. In general, we want to use JIRA as a way to have a very focused discussion about a specific bug, so we don't want the bug comments to be used like forums posts as a type of general discussion. Use the forums for this.
 +
 
 +
==== Fixing Bugs ====
 +
 
 +
When developers fix bugs, they can reference the issue(s) being fixed in the git commit message, by saying something like "This fixes FL-22". The funtoo-overlay and other repositories are integrated with JIRA, so you will be able to see links to these commits by going to the ''Commits'' tab for the issue.
 +
 
 +
==== Upstream Bug Reporting ====
 +
 
 +
Please report all bugs to us first, so we are aware of the issue. We will handle reporting bugs to upstream projects, including Gentoo Linux.

Revision as of 06:21, January 27, 2015

The Funtoo community's goal is to provide a seamless and problem-free computing experience, and we take all bugs seriously. Please use the following resources for reporting bugs, technical support, and troubleshooting assistance:

Collecting Info

Before submitting bugs collect information about your system, & problem.

# emerge --info > /tmp/emergeinfo.txt


Towards the end of failed emerges are messages about build logs.

Note

This is an example, your exact messages will vary. Use your emerge output rather than this example.

  • The complete build log is located at '/var/tmp/portage/sys-fs/lvm2-2.02.111/temp/build.log'

IRC

The #funtoo IRC channel on freenode available for informal, real-time technical support and troubleshooting. Please use Funtoo channels rather than Gentoo channels for Funtoo Linux support.

To share information on irc use Wgetpaste, and share links rather than posting directly to the channel.

Support Forums

The following Web-based discussion resources are specifically created for community-based support and troubleshooting, and are monitored by the Funtoo Linux core team. Under the new thread text area, attach the emerge info, and build logs directly to your posts rather than using wgetpaste links. Wgetpaste links expire where the forums attached files are timeless.

Bug tracker

We are using JIRA for tracking Funtoo Linux issues. See bugs.funtoo.org to access the bug tracker.

For information on how to properly use the bug tracker, see below.

How To Report Bugs

  1. First, Create a Funtoo account.
  2. Go to Issues -> Create Issue
  3. Set Issue Type to "Bug".
  4. For Summary, enter a clear description of the defect.
  5. For Description, enter:
    1. a clear, detailed description of the problem
    2. clear steps to reproduce the problem
    3. output of the failure
    4. a description of what you expected to happen instead of the failure
    5. attach emerge info, and build logs under bug description

When your issue is created, it will have a short name such as FL-17 that can be used to reference it.

Each issue is intended to track a specific defect in Funtoo Linux. Please respect the focus of each individual issue. Use the mailing lists and forums for general discussion.

Bug Status

When bugs are first reported, they are marked as Awaiting Review. This means that they are waiting to be reviewed by staff. Once reviewed and possibly revised somewhat, they will be moved into Queued status. This means that the bug has been accepted and is in queue to being fixed. When a developer starts working on the bug, it will move to In Progress status. This means that the bug is being actively worked on. When the bug is resolved, it will move to Test/Integration status, which means that it will now be tested and fully integrated into Funtoo Linux. When it has been fully integrated into Funtoo Linux, it will be marked as Closed, and the resolution will be set appropriately.

There are a few other statuses that are used. Upstream Review is used when a bug is submitted to an upstream project and is awaiting review or feedback. Workaround is used when a short-term fix is used to resolve a problem, but a longer-term fix is also required. There is also a Community Discussion status. This status is used when we are actively requesting community feedback. In general, we want to use JIRA as a way to have a very focused discussion about a specific bug, so we don't want the bug comments to be used like forums posts as a type of general discussion. Use the forums for this.

Fixing Bugs

When developers fix bugs, they can reference the issue(s) being fixed in the git commit message, by saying something like "This fixes FL-22". The funtoo-overlay and other repositories are integrated with JIRA, so you will be able to see links to these commits by going to the Commits tab for the issue.

Upstream Bug Reporting

Please report all bugs to us first, so we are aware of the issue. We will handle reporting bugs to upstream projects, including Gentoo Linux.