Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate wiki from bitbucket #338

Merged
merged 2 commits into from
Dec 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 78 additions & 0 deletions .github/workflows/publish-wiki.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# https://gohugo.io/hosting-and-deployment/hosting-on-github/
name: Deploy Wiki to Github Pages

on:
# Runs on pushes targeting the default branch
push:
branches:
- master
paths:
- 'docs/site/**'


# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

# Default to bash
defaults:
run:
shell: bash

jobs:
# Build job
build:
runs-on: ubuntu-latest
env:
HUGO_VERSION: 0.121.0
steps:
- name: Install Hugo CLI
run: |
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive
fetch-depth: 0
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4
- name: Build with Hugo
env:
# For maximum backward compatibility with Hugo modules
HUGO_ENVIRONMENT: production
HUGO_ENV: production
working-directory: ./docs/site
run: |
hugo \
--gc \
--minify \
--baseURL "${{ steps.pages.outputs.base_url }}/"
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./docs/site/public

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v3
3 changes: 3 additions & 0 deletions .github/workflows/releasing.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ on:
- release/*
tags-ignore:
- "*-snapshot"
paths-ignore:
- 'docs/site/**'

env:
PYTHON_BINARY: python3
jobs:
Expand Down
3 changes: 3 additions & 0 deletions .nolint
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,6 @@ config/idea/run/*.xml
# Gradle start scripts are provided by Gradle, we don't care much about what they contain
gradlew
gradlew.bat

# Hugo theme files
docs/site/themes/*
5 changes: 5 additions & 0 deletions docs/site/archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
+++
title = '{{ replace .File.ContentBaseName "-" " " | title }}'
date = {{ .Date }}
draft = true
+++
97 changes: 97 additions & 0 deletions docs/site/content/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# AndLogView: Log viewer for Android development

https://github.com/mlopatkin/andlogview

Android log viewer is the tool to simplify analysis of the Android logs.

![Application window](https://bitbucket.org/mlopatkin/android-log-viewer/wiki/multiple_filters.png)

![](/adb_setup_prompt.png)

## Features

- Display logs from a device or an emulator
- Display saved logs and dumpstate files
- Search in the logs using regex if needed
- Bookmarks
- Filter log lines by tag, PID, app name, log priority, message content
- Filtered lines can be hidden, highlighted or shown in a separate window
- Display any avaliable buffers: main, system, events, radio
- Save filtered lines
- Display process list

## Installing

Requirements:

- JRE 8+
- Android SDK (to work with a device or an emulator)

Unpack a zip archive to any folder.

Use the OS-specific script to launch AndLogView:

- `bin/andlogview.bat` (Windows)
- `bin/andlogview` (Linux)

Both scripts expect the javaw/java to be on your PATH.

## Overview: filters

The following filtering criteria are supported:

- Tag(s)
- Message text
- PID(s) and/or application name(s)
- Log priority

Filtered lines can be:

- Showed (all other lines will be hidden)
- Hidden
- Highlighted
- Showed in a separate window

You may enter several tags, application names or PIDs separated with commas, any
of them will be filtered. Message, tag and application name filters support
regular expressions. If several criteria are specified, only records that
match all of them will be filtered. If the tag or application name contain `,`
then `,` symbol should be doubled or the whole pattern should be enclosed in
backticks. For example, if you want to search for tags `Foo,bar` and `Bar,baz`
you should enter `Foo,,bar, Bar,,baz` or `` `Foo,bar`, `Bar,baz` ``. Wrapping
in backticks doesn't work for regular expressions.

## Overview: searching

1. `Ctrl+F` - show search field
2. Enter the pattern, then press `Enter` to start searching
3. `F3` - find next, `Shift+F3` - find previous
4. `Esc` - clear search results

You should wrap your pattern into `/.../` - slashes - to search using regular
expressions, ex. `/^[Aa].*$/` - all lines that start with lower or upper 'a'.
Regex-based searching is case-sensitive in opposite to a simple searching.
Standard Java regular expression syntax is used.

Searching is performed in application name, tag and message fields. You can
limit search scope to the single field by prefixing search request with `app:`,
`tag:`, or `msg:` respectively. Only one (first) prefix is in effect, others are
treated like normal search pattern.

## Overview: other

- The bookmarks windows can be used for quick jumping between marked lines.
Use context menu to add a line to bookmarks.
- You can copy log lines to the clipboard using `Ctrl+C`, `Ctrl+Ins` or the
context menu.
- Double-click on tag, message or pid cell opens edit mode where you can
select and copy a substring of the cell's content

See the complete manual at https://bitbucket.org/mlopatkin/android-log-viewer/wiki

## Contacts

There is a mailing list [android-log-viewer at Google Groups](https://groups.google.com/forum/#!forum/android-log-viewer)
for release announcements and discussions.

Please report bugs to https://github.com/mlopatkin/andlogview/issues
23 changes: 23 additions & 0 deletions docs/site/content/adb_mode/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Working with a device or an emulator
---
Logviewer can display logs directly from an emulator or a device if you have
the Android SDK installed. Simply run a launching script and the Logviewer
will try to connect to the first available device in the "adb devices" list.
If there is no available devices the tool will be waiting for a device to
connect.

You can use "ADB > Connect to device" in the main menu to select device
to connect to.

![Device selection window](select_device.png)

"ADB > Reset logs" command clears already retrieved logs, bookmarks
and processes list.

## ADB Configuration

"ADB > Configuration..." command opens the configuration window. You should
enter the path to the adb executable if it is not on the PATH.

![Configuration dialog](configuration.png)
Binary file added docs/site/content/adb_mode/configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/content/adb_mode/select_device.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading