Skip to content

Commit

Permalink
i#4111 web: Update stale wiki links (#4768)
Browse files Browse the repository at this point in the history
Updates links to the now-moved wiki pages.
Updates the Worklow page to remove a superfluous section layer.

Issue: #4111
  • Loading branch information
derekbruening authored Mar 6, 2021
1 parent a5fcea6 commit 605ff32
Show file tree
Hide file tree
Showing 30 changed files with 63 additions and 69 deletions.
6 changes: 2 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
name: Bug report
about: Create a report about a specific problem to help us improve
title: Please follow the guidelines in our wiki at https://github.com/DynamoRIO/dynamorio/wiki/Bug-Reporting
and use one of the CRASH, APP CRASH, HANG, or ASSERT keywords.
title: Edit me following https:///dynamorio.org/issues with one of the CRASH, APP CRASH, HANG, or ASSERT keywords.
labels: ''
assignees: ''

Expand Down Expand Up @@ -38,8 +37,7 @@ paste output here

**Versions**
- What version of DynamoRIO are you using?
- Does the latest build from
https://github.com/DynamoRIO/dynamorio/wiki/Latest-Build solve the problem?
- Does the latest build from https://github.com/DynamoRIO/dynamorio/releases solve the problem?
- What operating system version are you running on? ("Windows 10" is *not* sufficient: give the release number.)
- Is your application 32-bit or 64-bit?

Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ license](https://github.com/DynamoRIO/dynamorio/blob/master/License.txt).
Our wiki contains further information on policies, how to check out the
code, and how to add new code:

- [Contribution policies and suggestions](https://github.com/DynamoRIO/dynamorio/wiki/Contributing)
- [Git workflow](https://github.com/DynamoRIO/dynamorio/wiki/Workflow)
- [Code style guide](https://github.com/DynamoRIO/dynamorio/wiki/Code-Style)
- [Code content guidelines](https://github.com/DynamoRIO/dynamorio/wiki/Code-Content)
- [Code reviews](https://github.com/DynamoRIO/dynamorio/wiki/Code-Reviews)
- [Contribution policies and suggestions](https://dynamorio.org/page_contributing.html)
- [Git workflow](https://dynamorio.org/page_workflow.html)
- [Code style guide](https://dynamorio.org/page_code_style.html)
- [Code content guidelines](https://dynamorio.org/page_code_content.html)
- [Code reviews](https://dynamorio.org/page_code_reviews.html)

## Reporting issues

Expand All @@ -25,7 +25,7 @@ the issue tracker for the tool you are using and report the crash there.
To report issues in DynamoRIO itself, please follow the guidelines below.

For the Summary, please follow the [guidelines in our
wiki](https://github.com/DynamoRIO/dynamorio/wiki/Bug-Reporting) and use
bug reporting page](https://dynamorio.org/issues) and use
one of the CRASH, APP CRASH, HANG, or ASSERT keywords.

Please fill in the body of the issue with this template:
Expand All @@ -34,7 +34,7 @@ Please fill in the body of the issue with this template:
What version of DynamoRIO are you using?
Does the latest build from
https://github.com/DynamoRIO/dynamorio/wiki/Latest-Build solve the problem?
https://github.com/DynamoRIO/dynamorio/releases solve the problem?
What operating system version are you running on?
Expand All @@ -56,7 +56,7 @@ What steps will reproduce the problem?
What is the expected output? What do you see instead? Is this an
application crash, a DynamoRIO crash, a DynamoRIO assert, or a hang (see
https://github.com/DynamoRIO/dynamorio/wiki/Bug-Reporting and set the title
https://dynamorio.org/issues and set the title
appropriately)?
Expand Down
6 changes: 3 additions & 3 deletions README
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2010-2017 Google, Inc. licensed under the terms of the BSD. All other rights reserved.
Copyright (c) 2010-2021 Google, Inc. licensed under the terms of the BSD. All other rights reserved.
Copyright (c) 2000-2010 VMware, Inc. licensed under the terms of the BSD. All other rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down Expand Up @@ -116,10 +116,10 @@ order to execute them.
************************************************************
Instructions for building:

If you are building from source, please see the DynamoRIO wiki for
If you are building from source, please see the DynamoRIO site for
information on the required tools on both Windows and Linux:

https://github.com/DynamoRIO/dynamorio/wiki/How-To-Build
https://dynamorio.org/page_building.html

************************************************************
Getting help and reporting bugs:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Tools built on DynamoRIO and available in the [release package](https://dynamori
[drcpusim](https://dynamorio.org/page_drcpusim.html)
- The "strace for Windows" tool [drstrace](http://drmemory.org/strace_for_windows.html)
- The code coverage tool [drcov](https://dynamorio.org/page_drcov.html)
- The library tracing tool [drltrace](http://dynamorio.org/docs/page_drltrace.html)
- The library tracing tool [drltrace](http://dynamorio.org/page_drltrace.html)
- The memory address tracing tool [memtrace](https://github.com/DynamoRIO/dynamorio/blob/master/api/samples/memtrace_x86.c) ([drmemtrace](https://dynamorio.org/page_drcachesim.html)'s offline traces are faster with more surrounding infrastructure, but this is a simpler starting point for customized memory address tracing)
- The memory value tracing tool [memval](https://github.com/DynamoRIO/dynamorio/blob/master/api/samples/memval_simple.c)
- The instruction tracing tool [instrace](https://github.com/DynamoRIO/dynamorio/blob/master/api/samples/instrace_x86.c) ([drmemtrace](https://dynamorio.org/page_drcachesim.html)'s offline traces are faster with more surrounding infrastructure, but this is a simpler starting point for customized instruction tracing)
Expand All @@ -53,8 +53,8 @@ DynamoRIO's powerful API abstracts away the details of the underlying
infrastructure and allows the tool builder to concentrate on analyzing or
modifying the application's runtime code stream. API documentation is
included in the release package and can also be [browsed
online](http://dynamorio.org/page_user_docs.html/). [Slides from our past tutorials are
also available](https://github.com/DynamoRIO/dynamorio/wiki/Downloads).
online](http://dynamorio.org/page_user_docs.html). [Slides from our past tutorials are
also available](https://dynamorio.org/page_slides.html).

## Downloading DynamoRIO

Expand Down
2 changes: 1 addition & 1 deletion api/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
This directory contains the doxygen source for the DynamoRIO public API
and usage documentation, found at
[dynamorio.org](http://dynamorio.org/docs/index.html)
[dynamorio.org](http://dynamorio.org/index.html)
2 changes: 1 addition & 1 deletion api/docs/home.dox
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Tools built on DynamoRIO and available in the [release package](@ref page_downlo
[drcpusim](@ref page_drcpusim)
- The "strace for Windows" tool [drstrace](http://drmemory.org/strace_for_windows.html)
- The code coverage tool [drcov](@ref page_drcov)
- The library tracing tool [drltrace](http://dynamorio.org/docs/page_drltrace.html)
- The library tracing tool [drltrace](http://dynamorio.org/page_drltrace.html)
- The memory address tracing tool [memtrace](https://github.com/DynamoRIO/dynamorio/blob/master/api/samples/memtrace_x86.c) ([drmemtrace](@ref page_drcachesim)'s offline traces are faster with more surrounding infrastructure, but this is a simpler starting point for customized memory address tracing)
- The memory value tracing tool [memval](https://github.com/DynamoRIO/dynamorio/blob/master/api/samples/memval_simple.c)
- The instruction tracing tool [instrace](https://github.com/DynamoRIO/dynamorio/blob/master/api/samples/instrace_x86.c) ([drmemtrace](@ref page_drcachesim)'s offline traces are faster with more surrounding infrastructure, but this is a simpler starting point for customized instruction tracing)
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ldstex.dox
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ Disadvantages:

# Proposed Solution D: Run Twice

One idea is to treat these sequences in a similar manner to restartable sequences (“rseq”), which have relatively similar restrictions on execution. We handle those by running them twice, once with instrumentation and once “for real” natively with no instrumentation: https://github.com/DynamoRIO/dynamorio/wiki/Restartable-Sequences.
One idea is to treat these sequences in a similar manner to restartable sequences (“rseq”), which have relatively similar restrictions on execution. We handle those by running them twice, once with instrumentation and once “for real” natively with no instrumentation: \ref page_rseq.

We’d execute the whole sequence in a normal manner, with regular instrumentation. We’d remember the prior load-exclusive. When we see a store-exclusive, we then insert a native copy of the whole sequence since the load-exclusive, which is executed if the store-exclusive fails. If the native store-exclusive also fails, it would loop back to the start of the instrumented load-exclusive and repeat the whole process.

Expand Down
2 changes: 1 addition & 1 deletion api/docs/test_suite.dox
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ suite (if run with -V):

```
CMake Error: Some required settings in the configuration file were missing:
CTEST_SOURCE_DIRECTORY = E:/derek/opensource/withwiki/trunk/suite/..
CTEST_SOURCE_DIRECTORY = E:/derek/dr/suite/..
CTEST_BINARY_DIRECTORY = (Null)
CTEST_COMMAND = c:/PROGRA~2/CMAKE2~1.6/bin/ctest.exe
```
Expand Down
30 changes: 14 additions & 16 deletions api/docs/workflow.dox
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@

/**
****************************************************************************
\page page_workflow Workflow

# DynamoRIO Development Workflow
\page page_workflow Development Workflow

We use a centralized rebase workflow for our "master" branch combined with
feature branches. Each commit destined for master is first
Expand All @@ -49,7 +47,7 @@ rarely used.

[Code reviews use pull requests](@ref page_code_reviews).

## Getting the Code
# Getting the Code

Clone the repository, either via ssh if you've set up ssh keys in your
Github profile:
Expand All @@ -64,7 +62,7 @@ Or via https:
git clone https://github.com/DynamoRIO/dynamorio.git
~~~

## Configuring Author Information and Aliases
# Configuring Author Information and Aliases

Before doing anything on a fresh clone, run the development setup script (commands for updating and for code reviews depend on it):

Expand All @@ -74,7 +72,7 @@ make/git/devsetup.sh

Additionally, make sure that your full name is listed in the `Name` field at https://github.com/settings/profile and that a legitimate email address that represents you is set as your primary Github address at https://github.com/settings/emails. Those two fields will be used for the author line for pull requests when they are squash-and-merged into master. You must also uncheck `Keep my email address private` in the email settings page.

## Working on a Small Feature or Bug Fix
# Working on a Small Feature or Bug Fix

Small features or bug fixes, i.e., those that will become a single commit
in the master branch, use "feature branches".
Expand All @@ -94,15 +92,15 @@ git newbranch iNNNN-myfeature

Now perform your work in the feature branch, committing locally.

## Branch Naming Conventions
\section sec_branch_naming Branch Naming Conventions

For a small feature or bug fix, the name should start with the issue number prefixed by `i`, followed by a dash, followed by a short description. For example, `i2172-maps-parsing` or `i2157-reattach`. If there is no filed issue, use the `iX-` prefix. For example, `iX-fix-readme-typo`. If there will be multiple changes for an issue, create a different branch for each subsequent change, prefixing them with the same naming convention (i.e. `i` followed by issue number). For example: `i2172-refactoring-raw2trace`, `i2172-adding-wrappers`, etc. Note also the [change naming conventions](@ref sec_commit_messages) in such a case.

Although often a feature branch is short-lived, sometimes experimental work is not able to be finished immediately and there is value in sharing the code so that others can pick up on it. This is the logic behind using descriptive names for feature branches.

For an experimental branch (see below), the name should start with `experimental-`. For example, `experimental-jitopt`.

## Merging upstream changes
# Merging upstream changes

The `git pullall` alias runs a script that does the right type of update depending on whether you're in a feature branch that has not yet been pushed to the Github repository (where we want a rebase) or in a branch that has already been pushed (where we want to rebase from the remote feature branch and merge from the upstream master).

Expand All @@ -117,14 +115,14 @@ than a rebase to avoid losing history in the pull request, and `git pullall` wil

If you've pressed the Github button to update the feature branch with changes from master, and you now want to add a commit to your local branch (or have already added one), you want to pull the Github-added commit from the feature branch rather than master as a rebase. As mentioned, `git pullall` does that for you (along with updating from master).

## Requesting a Code Review and Merging to Master
# Requesting a Code Review and Merging to Master

Code reviews are requested by pushing the feature branch to Github and then
creating a pull request onto master. See
[code review details here](@ref page_code_reviews).
Merges to master occur only via pull request.

## Deleting a Feature Branch
# Deleting a Feature Branch

Once your changes have been merged into master, you can delete your feature
branch with these commands (substituting your branch's name for "feature"):
Expand All @@ -135,7 +133,7 @@ git pullall
git branch -d feature
~~~

## Checking Out an Existing Feature Branch
# Checking Out an Existing Feature Branch

You can check out an existing feature branch `iNNNN-name` via:

Expand All @@ -151,7 +149,7 @@ git fetch origin
git checkout -b iNNNN-name remotes/origin/iNNNN-name
~~~

## Splitting Up a Feature Branch
# Splitting Up a Feature Branch

If you want to split off the first commit or two from a feature branch and
you issue a command like this:
Expand All @@ -174,20 +172,20 @@ once with:
git split tocheckin 35d4e9c87de22ec9b3a8a110cae2d83821c88ee0
~~~

## Large Features or Projects
# Large Features or Projects

For larger features or projects which will end up containing many commits,
the workflow is unchanged. Work proceeds incrementally, with each small
piece being committed to master using a feature branch and pull request.

## Experimental Branches
# Experimental Branches

For experimental, quick-and-dirty work, especially where the work was already finished privately or where for time constraints and other reasons the regular development process is not suitable, we support experimental branches. The idea is to promote sharing of academic prototypes and other projects, with the goal of sharing the ideas immediately and making it more likely that the ideas will be eventually integrated into master, by separating the initial sharing from the later clean up and incremental code review. As described above, experimental branch names start with `experimental-`.

Please note that like other contributions, code contributed to an experimental branch is
[offered under the terms of our license](@ref page_contributing).

## Useful Aliases
# Useful Aliases

Some potentially useful aliases that are not in the development setup
script include the common tasks of looking at the log of changes versus the
Expand All @@ -203,7 +201,7 @@ And looking at the full diff versus the remote master:
git config alias.ddiff "diff origin/master.."
~~~

## No Merge Commits on Master
# No Merge Commits on Master

Our workflow uses fast-forward-merge and rebase when merging into the
master branch. We do not want any merge commits on the master
Expand Down
2 changes: 1 addition & 1 deletion api/samples/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This directory contains
[sample DynamoRIO clients](http://dynamorio.org/docs/API_samples.html),
[sample DynamoRIO clients](http://dynamorio.org/API_samples.html),
which can be directly
used for analysis or extended with additional functionality. Details about
each client can be found in the source code comments at the top of each file.
2 changes: 1 addition & 1 deletion clients/drcachesim/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[drcachesim](http://dynamorio.org/docs/page_drcachesim.html) is a DynamoRIO client
[drcachesim](http://dynamorio.org/page_drcachesim.html) is a DynamoRIO client
tool that gathers memory reference information from multiple processes
simultaneously and feeds it to an online cache simulator.
2 changes: 1 addition & 1 deletion clients/drcov/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[drcov](http://dynamorio.org/docs/page_drcov.html) is a DynamoRIO client tool that
[drcov](http://dynamorio.org/page_drcov.html) is a DynamoRIO client tool that
collects code coverage information.
2 changes: 1 addition & 1 deletion clients/drcpusim/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[drcpusim](http://dynamorio.org/docs/page_drcpusim.html) is a DynamoRIO
[drcpusim](http://dynamorio.org/page_drcpusim.html) is a DynamoRIO
client tool that emulates execution on a specified CPU model in order to
validate that a target application does not execute any instructions that
are illegal or not implemented on a legacy processor.
2 changes: 1 addition & 1 deletion core/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This directory contains the core implementation of DynamoRIO. Documentation for
client developers can be found in the [public API](http://dynamorio.org/docs/index.html),
client developers can be found in the [public API](http://dynamorio.org/index.html),
where interface and data structures are found in the *Files* and *Data Structures* tabs,
respectively.
6 changes: 3 additions & 3 deletions core/annotations.c
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* ******************************************************
* Copyright (c) 2014-2020 Google, Inc. All rights reserved.
* Copyright (c) 2014-2021 Google, Inc. All rights reserved.
* ******************************************************/

/*
Expand Down Expand Up @@ -839,7 +839,7 @@ valgrind_running_on_valgrind(dr_vg_client_request_t *request)
* (note there is a special case for Windows x64, which is not inline asm)
* (step 7) if it matches, point `**name` to the character beyond the separator ':'
*
* See https://github.com/DynamoRIO/dynamorio/wiki/Annotations for complete examples.
* See https://dynamorio.org/page_annotations.html for complete examples.
*/
static inline bool
is_annotation_tag(dcontext_t *dcontext, IN OUT app_pc *cur_pc, instr_t *scratch,
Expand Down Expand Up @@ -947,7 +947,7 @@ identify_annotation(dcontext_t *dcontext, IN OUT annotation_layout_t *layout,
/* If the target app contains an annotation whose argument is a function call
* that gets inlined, and that function contains the same annotation, the
* compiler will fuse the headers. See
* https://github.com/DynamoRIO/dynamorio/wiki/Annotations for a sample of
* https://dynamorio.org/page_annotations.html for a sample of
* fused headers. This loop identifies and skips any fused headers.
*/
while (true) {
Expand Down
2 changes: 1 addition & 1 deletion core/arch/aarch64/emit_utils.c
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
* appropriate offset in ldr for the 8-byte aligned 8 byte region within it.
*
* For complete design details, see the following wiki
* https://github.com/DynamoRIO/dynamorio/wiki/Linking-Far-Fragments-on-AArch64
* https://dynamorio.org/page_aarch64_far.html
*/

byte *
Expand Down
8 changes: 3 additions & 5 deletions core/arch/aarchxx/mangle.c
Original file line number Diff line number Diff line change
Expand Up @@ -2955,9 +2955,8 @@ mangle_icache_op(dcontext_t *dcontext, instrlist_t *ilist, instr_t *instr,

/***************************************************************************
* Exclusive load/store mangling.
* See the design doc at
* https://github.com/DynamoRIO/dynamorio/wiki/Exclusive-Monitors for background
* information.
* See the design doc at https://dynamorio.org/page_ldstex.html
* for background information.
*/

static instr_t *
Expand Down Expand Up @@ -3611,8 +3610,7 @@ mangle_exclusive_monitor_op(dcontext_t *dcontext, instrlist_t *ilist, instr_t *i
/* For -ldstex2cas we convert exclusive monitor regions into compare-and-swap
* operations in order to allow regular instrumentation, with the downside of
* weaker synchronization semantics.
* See https://github.com/DynamoRIO/dynamorio/wiki/Exclusive-Monitors for
* background and further details.
* See https://dynamorio.org/page_ldstex.html for background and further details.
* The summary is:
* + On an exclusive load, save the address, value, opcode, and size,
* and convert to a non-exclusive load.
Expand Down
4 changes: 2 additions & 2 deletions core/lib/dr_annotations_asm.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* ******************************************************
* Copyright (c) 2014-2020 Google, Inc. All rights reserved.
* Copyright (c) 2014-2021 Google, Inc. All rights reserved.
* ******************************************************/

/*
Expand Down Expand Up @@ -34,7 +34,7 @@
#define _DYNAMORIO_ANNOTATIONS_ASM_H_ 1

/* This header defines the annotation functions and code sequences. For a high-level
* overview, see the wiki page https://github.com/DynamoRIO/dynamorio/wiki/Annotations.
* overview, see https://dynamorio.org/page_annotations.html.
*/

/* To simplify project configuration, this pragma excludes the file from GCC warnings. */
Expand Down
Loading

0 comments on commit 605ff32

Please sign in to comment.